WHAT YOU WILL FIND HERE
-----------------------

An experimental project called 'waf' (bsd licence: freely redistributable)
Examples can be found in demo/
Tests can be found in wafadmin/ (run ./Test.py and look at the folder wafadmin/test/)

GENERATE WAF
------------

Run './waf-light --make-waf' to generate waf or look at './waf-light --help'

Then try 'waf --help', there are predefined targets for waf itself.

ENVIRONMENT VARIABLES
---------------------

WAF_HOME: where .wafcache (configuration cache) and .waf-x.y.z (library cache) will be stored
WAFLOCK: name of the lock file (default: .lock-wscript)
WAFDIR: path to the wafadmin folder (developers must set it)
WAFCACHE: path to the target cache (replaces --usecache)

QUICK HOWTO
-----------

Environment setup:
  For your convenience the script 'aliases.sh' contains useful aliases:
  'source aliases.sh' will set your environment.

Starting a new project with waf:
  Copy the 'waf' script to your project.

  Add sources in a subdirectory (this is how programs are built in real life), and a wscript on the top-level.

Using waf:
  To begin with, have a look at the cpp demo first (demos/cpp):
  * configure with "waf configure"
  * compile with "waf"
  * install with "waf install"
  * create a tarball with "waf dist"
  * clean with "waf distclean"

Creating scripts:
  * The wscript are actually python modules, from which functions with particular namings
  are imported. For more details on the functions to provide have a look at the file DESIGN.
  * In some cases, there is a lot of code and using a build(bld) function is not convenient:
  a file named wscript_build ('wscript_'+function name) will replace the
  corresponding function in the wscript module. See demos/cpp/src2

DEVELOPERS
----------

Developers must set WAFDIR
A cache in $HOME/.waf-version may cause problems between svn updates
(the version number is not always incremented between changes)

---------------------------
Thomas Nagy, 2006 (ita)

