README

   1 WHAT YOU WILL FIND HERE
   2 -----------------------
   3
   4 Waf 1.8 - for Waf 1.7 use the branch waf-1.7
   5
   6 For the manual: http://docs.waf.googlecode.com/git/book_16/single.html
   7 For the api docs: http://docs.waf.googlecode.com/git/apidocs_16/index.html
   8 For the examples: see the folder demos/
   9
  10 HOW TO CREATE THE WAF SCRIPT
  11 ----------------------------
  12
  13 Python 2.6, 2.7, 3.0, 3.1, 3.2, 3.3 or 3.4 is required to generate the waf script. The waf script is then the version that can run on Python 2.5.
  14 Just execute:
  15 $ ./waf-light configure build
  16 Or, if you have several python versions installed:
  17 $ python3 ./waf-light configure build
  18
  19 The Waf tools in waflib/extras are not added to the waf script. To add
  20 some of them, use the --tools switch:
  21 $ ./waf-light --tools=compat15,swig
  22
  23 To add a tool that does not exist in the folder extras, pass an absolute path, and
  24 to customize the initialization, pass the parameter 'prelude'. Here is for example
  25 how to create a waf file using the compat15 module:
  26 $ ./waf-light --tools=compat15 --prelude=$'\tfrom waflib.extras import compat15\n'
  27
  28 Any kind of initialization is possible, though one may prefer the build system kit (folder build_system_kit):
  29 $ ./waf-light --make-waf --tools=compat15,/comp/waf/aba.py --prelude=$'\tfrom waflib.extras import compat15\n\tprint("ok")'
  30
  31 Or if you do not want to regenerate the waf file all the time, set the WAFDIR environment variable to the directory containing "waflib".
  32
  33 HOW TO TRY THE EXAMPLES
  34 -----------------------
  35
  36 Try this:
  37 $ cp waf demos/c/
  38 $ cd demos/c/
  39 $ ./waf configure build
  40
  41 USING GIT
  42 ---------
  43
  44 $ git clone https://code.google.com/p/waf/
  45 set $HOME/.netrc to read:
  46 machine code.google.com login user@gmail.com password pass
  47 $ git remote add code https://code.google.com/p/waf.docs/
  48 ... make a few changes
  49 $ git push code
  50
  51 ---------------------------
  52 Thomas Nagy, 2014-2015 (ita)
  53