1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/BUILD	Tue Aug 29 18:08:51 2006 +0200
     1.3 @@ -0,0 +1,75 @@
     1.4 +If you want to build ns3, you need to install scons (see
     1.5 +http://www.scons.org). scons takes care of building
     1.6 +the whole source tree using your system compiler. scons
     1.7 +0.91.1 and 0.91.96 have been tested and are known to 
     1.8 +work on linux FC5, Mac os X and MinGW.
     1.9 +
    1.10 +To start a build, you can just type 'scons' which
    1.11 +will generate a debug shared build by default, located
    1.12 +in the directory 'build-dir/dbg-shared/bin' and
    1.13 +'build-dir/dbg-shared/lib'.
    1.14 +
    1.15 +1) Options
    1.16 +----------
    1.17 +
    1.18 +- verbose: if you have install scons 0.91.96, the default
    1.19 +  build output is terse. To get a more verbose output, you
    1.20 +  need to set the 'verbose' variable to 'y'.
    1.21 +
    1.22 +Example:
    1.23 +scons verbose=y
    1.24 +
    1.25 +2) Targets
    1.26 +----------
    1.27 +
    1.28 +- dbg-shared: a debug build using shared libraries.
    1.29 +  The files are built in 'build-dir/dbg-shared/'.
    1.30 +Example:
    1.31 +scons dbg-shared
    1.32 +
    1.33 +- dbg-static: a debug build using static libraries
    1.34 +  The files are built in 'build-dir/dbg-static/'.
    1.35 +Example:
    1.36 +scons dbg-static
    1.37 +
    1.38 +- opt-shared: an optimized build using shared libraries.
    1.39 +  The files are built in 'build-dir/opt-shared/'.
    1.40 +Example:
    1.41 +scons opt-shared
    1.42 +
    1.43 +- opt-static: an optimized build using static libraries.
    1.44 +  The files are built in 'build-dir/opt-static/'.
    1.45 +Example:
    1.46 +scons opt-static
    1.47 +
    1.48 +- dbg: an alias for dbg-shared
    1.49 +Example:
    1.50 +scons dbg
    1.51 +
    1.52 +- opt: an alias for opt-shared
    1.53 +Example:
    1.54 +scons opt
    1.55 +
    1.56 +- all: alias for dbg-shared, dbg-static, opt-shared 
    1.57 +  and opt-static
    1.58 +Example:
    1.59 +scons all
    1.60 +
    1.61 +- dist: generate a release tarball and zipfile from the 
    1.62 +  source tree. The tarball and zipfile name are generated
    1.63 +  according to the version number stored in the SConstruct
    1.64 +  file.
    1.65 +Example in SConstruct:
    1.66 +ns3 = Ns3 ()
    1.67 +ns3.name = 'foo'
    1.68 +ns3.version = '0.0.10'
    1.69 +Example command:
    1.70 +scons dist
    1.71 +Example output:
    1.72 +foo-0.0.10.tar.gz
    1.73 +foo-0.0.10.zip
    1.74 +
    1.75 +- distcheck: generate a release tarball and zipfile and 
    1.76 +  attempt to run the 'all' target for the release tarball.
    1.77 +Example:
    1.78 +scons distcheck