README
author Tom Henderson <tomh@tomh.org>
Thu, 02 Jul 2009 21:57:00 -0700
changeset 4646 c25ca2e38845
parent 3760 cfc585a0ea16
permissions -rw-r--r--
some fixes to the manual for IPv4 refactoring
     1 
     2     The Network Simulator, Version 3
     3     --------------------------------
     4 
     5 Table of Contents:
     6 ------------------
     7 
     8 1) An overview
     9 2) Building ns-3
    10 3) Running ns-3
    11 4) Getting access to the ns-3 documentation
    12 5) Working with the development version of ns-3
    13 
    14 Note:  Much more substantial information about ns-3 can be found at
    15 http://www.nsnam.org
    16 
    17 1) An Open Source project
    18 -------------------------
    19 
    20 ns-3 is a free open source project aiming to build a discrete-event
    21 network simulator targeted for simulation research and education.   
    22 This is a collaborative project; we hope that
    23 the missing pieces of the models we have not yet implemented
    24 will be contributed by the community in an open collaboration
    25 process.
    26 
    27 Contributing to the ns-3 project is still a very informal
    28 process because that process depends heavily on the background
    29 of the people involved, the amount of time they can invest
    30 and the type of model they want to work on.  
    31 
    32 Despite this lack of a formal process, there are a number of 
    33 steps which naturally stem from the open-source roots of the
    34 project.  These steps are described in doc/contributing.txt
    35 
    36 2) Building ns-3
    37 ----------------
    38 
    39 The code for the framework and the default models provided
    40 by ns-3 is built as a set of libraries. User simulations
    41 are expected to be written as simple programs that make
    42 use of these ns-3 libraries.
    43 
    44 To build the set of default libraries and the example
    45 programs included in this package, you need to use the
    46 tool 'waf'. Detailed information on how use waf is 
    47 included in the file doc/build.txt
    48 
    49 However, the real quick and dirty way to get started is to
    50 type the command "./waf configure; ./waf" the the directory which contains
    51 this README file. The files built will be copied in the
    52 build/debug or build/optimized.
    53 
    54 The current codebase is expected to build and run on the
    55 set of platforms listed in the RELEASE_NOTES file.
    56 
    57 Other platforms may or may not work: we welcome patches to 
    58 improve the portability of the code to these other platforms. 
    59 
    60 3) Running ns-3
    61 ---------------
    62 
    63 On recent Linux systems, once you have built ns-3, it 
    64 should be easy to run the sample programs with the
    65 following command:
    66 
    67 ./waf --run simple-global-routing
    68 
    69 That program should generate a simple-global-routing.tr text 
    70 trace file and a set of simple-global-routing-xx-xx.pcap binary
    71 pcap trace files, which can be read by tcpdump -tt -r filename.pcap
    72 
    73 4) Getting access to the ns-3 documentation
    74 -------------------------------------------
    75 
    76 Once you have verified that your build of ns-3 works by running
    77 the simple-point-to-point example as outlined in 4) above, it is
    78 quite likely that you will want to get started on reading
    79 some ns-3 documentation. 
    80 
    81 All of that documentation should always be available from
    82 the ns-3 website: http:://www.nsnam.org/ but we
    83 include some of it in this release for ease of use.
    84 
    85 This documentation includes:
    86 
    87   - a tutorial
    88  
    89   - a manual
    90 
    91   - a wiki for user-contributed tips: http://www.nsnam.org/wiki/
    92 
    93   - an API documentation generated using doxygen: this is
    94     a reference manual, most likely not very well suited 
    95     as introductory text:
    96     http://www.nsnam.org/doxygen/index.html
    97 
    98 5) Working with the development version of ns-3
    99 -----------------------------------------------
   100 
   101 If you want to download and use the development version 
   102 of ns-3, you need to use the tool 'mercurial'. A quick and
   103 dirty cheat sheet is included in doc/mercurial.txt but
   104 reading through the mercurial tutorials included on the
   105 mercurial website is usually a good idea if you are not
   106 familiar with it.
   107 
   108 If you have successfully installed mercurial, you can get
   109 a copy of the development version with the following command:
   110 "hg clone http://code.nsnam.org/ns-3-dev"