README
changeset 657 be551a3b07c6
parent 655 f2ee52034178
child 663 48c05ee9fb6a
     1.1 --- a/README	Fri May 18 18:03:48 2007 +0200
     1.2 +++ b/README	Fri May 18 10:27:42 2007 -0700
     1.3 @@ -1,9 +1,9 @@
     1.4  
     1.5 -    The Network Simulator Version 3
     1.6 -    -------------------------------
     1.7 +    The Network Simulator, Version 3
     1.8 +    --------------------------------
     1.9  
    1.10 -Table of Content:
    1.11 ------------------
    1.12 +Table of Contents:
    1.13 +------------------
    1.14  
    1.15  1) An Open Source project
    1.16  2) An overview of the ns-3 project
    1.17 @@ -16,7 +16,7 @@
    1.18  1) An Open Source project
    1.19  -------------------------
    1.20  
    1.21 -ns-3 is an Open Source project and we intend to make this
    1.22 +ns-3 is an Open Source project.   We intend to make this
    1.23  project a successful collaborative project: we hope that 
    1.24  the missing pieces of the models we have not yet implemented
    1.25  will be contributed by the community in an open collaboration
    1.26 @@ -25,11 +25,11 @@
    1.27  Contributing to the ns-3 project is still a very informal
    1.28  process because that process depends heavily on the personality
    1.29  of the people involved, the amount of time they can invest
    1.30 -and the type of model they want to work on.
    1.31 +and the type of model they want to work on.  
    1.32  
    1.33  Despite this lack of a formal process, there are a number of 
    1.34  steps which naturally stem from the open-source roots of the
    1.35 -project. These steps are described in doc/contributing.txt
    1.36 +project.  These steps are described in doc/contributing.txt
    1.37  
    1.38  2) An overview of the ns-3 project
    1.39  ----------------------------------
    1.40 @@ -42,8 +42,9 @@
    1.41    - point-to-point physical-layer links
    1.42    - OnOff traffic generator
    1.43  
    1.44 -However, the framework is there to make adding new models as 
    1.45 -simple as possible:
    1.46 +Our focus to date has been on getting an overall software
    1.47 +framework in place.  The framework is there to make adding 
    1.48 +new models as simple as possible:
    1.49    - an extensive tracing system can be used to connect
    1.50      any number of arbitrary trace sources to any number
    1.51      of trace sinks. This tracing system is decoupled
    1.52 @@ -65,7 +66,7 @@
    1.53  
    1.54  The code for the framework and the default models provided
    1.55  by ns-3 is built as a set of libraries. User simulations
    1.56 -are expected to be written as simple programs which make
    1.57 +are expected to be written as simple programs that make
    1.58  use of these ns-3 libraries.
    1.59  
    1.60  To build the set of default libraries and the example
    1.61 @@ -92,14 +93,14 @@
    1.62    - gcc 3.3 and earlier
    1.63    - optimized builds on linux x86 gcc 4.0 
    1.64  
    1.65 -Other platforms might or might not work: we welcome 
    1.66 +Other platforms may or may not work: we welcome 
    1.67  patches to improve the portability of the code to these
    1.68  other platforms.
    1.69  
    1.70  4) Running ns-3
    1.71  ---------------
    1.72  
    1.73 -On Recent Linux systems, once you have built ns-3, it 
    1.74 +On recent Linux systems, once you have built ns-3, it 
    1.75  should be easy to run the sample programs with the
    1.76  following command:
    1.77  
    1.78 @@ -112,7 +113,7 @@
    1.79  
    1.80  That program should generate a simple-p2p.tr text 
    1.81  trace file and a set of simple-p2p-xx-xx.pcap binary
    1.82 -pcap trace files.
    1.83 +pcap trace files, which can be read by tcpdump.
    1.84  
    1.85  5) Getting access to the ns-3 documentation
    1.86  -------------------------------------------
    1.87 @@ -166,4 +167,4 @@
    1.88  If you have successfully installed mercurial, you can get
    1.89  a copy of the development version with the following
    1.90  command:
    1.91 -"hg clone http://code.nsnam.org/ns-3-dev"
    1.92 \ No newline at end of file
    1.93 +"hg clone http://code.nsnam.org/ns-3-dev"