Improve INSTALL file.

git-svn-id: http://svn.drobilla.net/lad/trunk/suil@4523 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 41 insertions, 17 deletions

diff --git a/INSTALL b/INSTALL
index f6e4dd4..623cddd 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,35 +1,59 @@
-This software requires only Python to build.
+Installation Instructions
+=========================
 
-Like an auto* project, building has three phases:
+Basic Installation
+------------------
 
+Building this software requires only Python.  To install with default options:
 
-* Configure:       ./waf configure [OPTIONS]
+    ./waf configure
+    ./waf
+    ./waf install
 
-  Example:
-    ./waf configure --prefix=/some/where --debug --strict
+You may need to become root for the install stage, for example:
 
-  If --debug is not given, the flags from the environment variables
-  CFLAGS and CXXFLAGS will be used.
+    sudo ./waf install
 
-  The default prefix is /usr/local
+Configuration Options
+---------------------
 
+All supported options can be viewed using the command:
 
-* Build:           ./waf [OPTIONS]
+    ./waf --help
 
-  Example:
-    ./waf -j4
+Most options only need to be passed during the configure stage, for example:
 
+    ./waf configure --prefix=/usr
+    ./waf
+    ./waf install
 
-* Install:         ./waf install [OPTIONS]
+Compiler Configuration
+----------------------
 
-  The environment variable DESTDIR can be used to add any prefix to
-  the install paths (useful for packaging).  Example:
+Several standard environment variables can be used to control how compilers are
+invoked:
 
-  DESTDIR=/home/drobilla/packages ./waf install
+ * CC:        Path to C compiler
+ * CFLAGS:    C compiler options
+ * CXX:       Path to C++ compiler
+ * CXXFLAGS:  C++ compiler options
+ * CPPFLAGS:  C preprocessor options
+ * LINKFLAGS: Linker options
 
+Installation Directories
+------------------------
 
-*** IMPORTANT: You must use absolute paths everywhere
+The --prefix option (or the PREFIX environment variable) can be used to change
+the prefix which all files are installed under.  There are also several options
+allowing for more fine-tuned control, see the --help output for details.
 
+Packaging
+---------
 
-Run './waf --help' for detailed option information.
+Everything can be installed to a specific root directory by passing a --destdir
+option to the install stage (or setting the DESTDIR environment variable),
+which adds a prefix to all install paths.  For example:
 
+    ./waf configure --prefix=/usr
+    ./waf
+    ./waf install --destdir=/tmp/package