cannam@85: Installation Instructions
cannam@85: =========================
cannam@85: 
cannam@85: Basic Installation
cannam@85: ------------------
cannam@85: 
cannam@85: Building this software requires only Python.  To install with default options:
cannam@85: 
cannam@85:     ./waf configure
cannam@85:     ./waf
cannam@85:     ./waf install
cannam@85: 
cannam@85: You may need to become root for the install stage, for example:
cannam@85: 
cannam@85:     sudo ./waf install
cannam@85: 
cannam@85: Configuration Options
cannam@85: ---------------------
cannam@85: 
cannam@85: All supported options can be viewed using the command:
cannam@85: 
cannam@85:     ./waf --help
cannam@85: 
cannam@85: Most options only need to be passed during the configure stage, for example:
cannam@85: 
cannam@85:     ./waf configure --prefix=/usr
cannam@85:     ./waf
cannam@85:     ./waf install
cannam@85: 
cannam@85: Compiler Configuration
cannam@85: ----------------------
cannam@85: 
cannam@85: Several standard environment variables can be used to control how compilers are
cannam@85: invoked:
cannam@85: 
cannam@85:  * CC:        Path to C compiler
cannam@85:  * CFLAGS:    C compiler options
cannam@85:  * CXX:       Path to C++ compiler
cannam@85:  * CXXFLAGS:  C++ compiler options
cannam@85:  * CPPFLAGS:  C preprocessor options
cannam@85:  * LINKFLAGS: Linker options
cannam@85: 
cannam@85: Installation Directories
cannam@85: ------------------------
cannam@85: 
cannam@85: The --prefix option (or the PREFIX environment variable) can be used to change
cannam@85: the prefix which all files are installed under.  There are also several options
cannam@85: allowing for more fine-tuned control, see the --help output for details.
cannam@85: 
cannam@85: Packaging
cannam@85: ---------
cannam@85: 
cannam@85: Everything can be installed to a specific root directory by passing a --destdir
cannam@85: option to the install stage (or setting the DESTDIR environment variable),
cannam@85: which adds a prefix to all install paths.  For example:
cannam@85: 
cannam@85:     ./waf configure --prefix=/usr
cannam@85:     ./waf
cannam@85:     ./waf install --destdir=/tmp/package