move check for gimp and firefox to when needed, to allow soft require
[booh] / INSTALL
1 This software requires for compiling:
2
3 - gtk >= 2.8
4 - devel of gtk
5 - ruby
6 - ruby-gettext >= 0.8.0
7 - ruby-gtk2 >= 0.12
8 - devel of ruby-gnome2 (mkmf-gnome2.rb, rbgobject.h)
9 - devel of libexiv2 (and thus, g++)
10
11     Note: theoretically, gtk and ruby-gtk2 are not needed if
12     you're gonna use only the backend script (the only lost
13     functionality is white balance correction which uses
14     gdk_pixbuf). However, the GUI is an important part of this
15     software and its use is encouraged (it helps a lot).
16
17 And for runtime:
18
19 - convert (from ImageMagick) - for photos thumbnails generation
20 - identify (from ImageMagick) - for photos captions
21 - exif - to show full formatted EXIF information from photos
22 - mplayer - for videos thumbnails generation
23 - gimp - for photos editing (may not be a hard require)
24 - mozilla-firefox - for showing albums in browser, and going on the
25   web for tutorials (may not be a hard require)
26
27
28         Compiling and Installing Quick Start
29
30 Type this as normal user:
31
32  # ruby setup.rb config
33  # ruby setup.rb setup
34  # cd ext
35  # ruby extconf.rb && make
36
37 And type this as superuser:
38
39  $ ruby setup.rb install
40  $ cd ext
41  $ make install
42
43 If you want to package as normal user to another root:
44
45  $ ruby_archdir=`ruby -rrbconfig -e "puts Config::CONFIG['sitearchdir']"`
46  $ libdir=`ruby -rrbconfig -e "puts Config::CONFIG['sitelibdir']"`
47  $ rm -rf ${buildroot}
48  $ ruby setup.rb install --prefix=${buildroot}
49  $ cd ext
50  $ make install DESTDIR=${buildroot} libdir=${buildroot}${libdir} archdir=${buildroot}${ruby_archdir}
51
52 Note: it will install things in traditional directories plus
53 ruby_archdir and ruby_libdir.
54 Change FPATH in ${buildroot}/local/lib/site_ruby/1.8/booh/config.rb to suit your $buildroot
55
56 Find desktop stuff (.desktop entry and icons) for your menu/packaging system
57 in the destkop/ subdir.