doc: update INSTALL on how to build from git
authorMarko Kreen <markokr@gmail.com>
Mon, 13 Apr 2009 13:05:18 +0000 (16:05 +0300)
committerMarko Kreen <markokr@gmail.com>
Mon, 13 Apr 2009 13:05:18 +0000 (16:05 +0300)
INSTALL

diff --git a/INSTALL b/INSTALL
index 495c4f1352a9520e18dbbb2b3835ec2786709008..fc4d3eedef5a8aeb5c06ba322a40fc364389a564 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,11 +14,10 @@ skytool applications.
 
   postgresql libpq-dev postgresql-server-dev
   python python-dev
-  libevent-dev
 
-When building code from CVS:
+When building code from GIT:
 
-  autoconf asciidoc xmlto
+  git autoconf asciidoc xmlto
 
 === Runtime dependencies ===
 
@@ -26,11 +25,33 @@ When building code from CVS:
   psycopg2 or psycopg1
   rsync
 
+== Building from source tarball ==
+
+  $ ./configure --prefix=...
+  $ make
+  $ make install
+
+== Building from GIT ==
+
+  ## fetch git tree
+  $ git clone git://github.com/markokr/skytools-dev.git
+
+  ## fetch libusual submodule
+  $ git submodule init
+  $ git submodule update
+
+  ## generate ./configure script
+  $ make boot
+
+  ## now build as usual (--with-asciidoc is required when building from GIT)
+  $ ./configure --prefix=... --with-asciidoc
+  $ make
+
 == Building a debian package ==
 
 The main Makefile provides a target for building a +.deb+ package
-suitable for installation. You need to install some additional
-packages to be able to build the debian package:
+suitable for installation.  Following additional packages are needed
+to build the debian package:
 
   devscripts yada
 
@@ -46,27 +67,22 @@ The build should give you two debian package files to install, such as
 +skytools-modules-8.2_2.1.5_i386.deb+. See the Installation section
 for notes about where to install those packages.
 
-== Building for other systems ==
-
-The build and install from sources step are the following:
-
-  $ ./configure [--prefix] [--with-python] [--with-pgconfig] [--with-asciidoc]
-  $ make
-  $ sudo make install
+== Optional arguments to ./configure ==
 
 The following configure options are available:
 
 --prefix::
-  path prefix where to install skytools files (default: UNKNOWN)
+  Path prefix where to install skytools files (default: /usr/local)
   
 --with-python::
-  name of the Python executable (default: python)
+  Name or full path of the Python executable to use. (default: python)
   
 --with-pgconfig::
-  path to pg_config (default: pg_config)
+  Name or full path to pg_config (default: pg_config)
 
 --with-asciidoc
-  If asciidoc should be used to re-generate manpages.
+  If asciidoc should be used to re-generate manpages.  Required when
+  building from GIT as the generated pages are not in repo.
 
 
 == Documentation ==
@@ -106,6 +122,3 @@ the +londiste.py+ command line tool.
 
 Please refer to the documentation.
 
-
-
-