improve INSTALL doc
authorgc <gc>
Tue, 2 Aug 2005 19:48:00 +0000 (19:48 +0000)
committergc <gc>
Tue, 2 Aug 2005 19:48:00 +0000 (19:48 +0000)
INSTALL

diff --git a/INSTALL b/INSTALL
index d6c147e..802ee01 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,32 +1,50 @@
-This software requires:
+This software requires for compiling:
 
+- gtk >= 2.6
 - ruby
 - ruby-gettext >= 0.8.0
-- ruby-gtk2
+- ruby-gtk2 >= 0.12
 - devel of ruby-gnome2 (mkmf-gnome2.rb, rbgobject.h)
 
+    Note: theoretically, gtk and ruby-gtk2 are not needed if
+    you're gonna use only the backend script (the only lost
+    functionality is white balance correction which uses
+    gdk_pixbuf). However, the GUI is an important part of this
+    software and its use is encouraged (it helps a lot).
 
-        Quick Start
+And for runtime:
 
-Type this (You might needs super user previledge):
+- exif (the binary - coming from http://sourceforge.net/projects/libexif)
+- convert/identify (from ImageMagick)
+- transcode (not strictly needed if you won't manipulate any video)
+- mencoder (id.)
 
-($ su)
- # ruby setup.rb
+
+        Compiling and Installing Quick Start
+
+Type this as normal user:
+
+ # ruby setup.rb config
+ # ruby setup.rb setup
  # cd ext
  # ruby extconf.rb
- # make install
+ # make
+
+And type this as superuser:
 
+ $ ruby setup.rb install
+ $ cd ext
+ $ make install
 
-        Detailed Installation Process
+If you want to package as normal user to another root:
+ $ rm -rf %buildroot
+ $ ruby setup.rb install --prefix=%buildroot
+ $ cd ext
+ $ make install DESTDIR=%buildroot libdir=%buildroot%{_libdir} archdir=%buildroot%ruby_archdir
 
-setup.rb invokes installation by three steps. There are "config",
-"setup" and "install". You can invoke each steps separately as
-following:
+ ruby_archdir being the result of: ruby -rrbconfig -e "puts Config::CONFIG['sitearchdir']"
 
-$ ruby setup.rb config
-$ ruby setup.rb setup
-# ruby setup.rb install
+Note: it will install things in traditional directories plus
+ruby_archdir and ruby_libdir, the latter one being the result of
+ruby -rrbconfig -e "puts Config::CONFIG['sitelibdir']"
 
-You can control installation process by giving detailed options
-for each tasks. For example, --bin-dir=$HOME/bin let setup.rb
-install commands in $HOME/bin.