121 the simple-p2p example as outlined in 4) above, it is |
121 the simple-p2p example as outlined in 4) above, it is |
122 quite likely that you will want to get started on reading |
122 quite likely that you will want to get started on reading |
123 some ns-3 documentation. |
123 some ns-3 documentation. |
124 |
124 |
125 All of that documentation should always be available from |
125 All of that documentation should always be available from |
126 the ns-3 website: http:://www.nsnam.org/ |
126 the ns-3 website: http:://www.nsnam.org/ but we |
|
127 include some of it in this release for ease of use. |
127 |
128 |
128 It includes: |
129 This documentation includes: |
129 |
130 |
130 - an architecture document which describes a very |
131 - an architecture document which describes a very |
131 high-level view of ns-3: it tries to explain the |
132 high-level view of ns-3: it tries to explain the |
132 use-cases the ns-3 developers really focused on when |
133 use-cases the ns-3 developers really focused on when |
133 doing the initial design and then goes on to explain |
134 doing the initial design and then goes on to explain |
134 the structure of the resulting framework. |
135 the structure of the resulting framework. |
135 XXX introduce url link |
136 See the file doc/architecture.pdf |
136 |
|
137 - a user manual: XXX |
|
138 |
137 |
139 - a wiki for user-contributed tips: http://www.nsnam.org/wiki/ |
138 - a wiki for user-contributed tips: http://www.nsnam.org/wiki/ |
140 |
139 |
141 - an API documentation generated using doxygen: this is |
140 - an API documentation generated using doxygen: this is |
142 a reference manual, most likely not very well suited |
141 a reference manual, most likely not very well suited |
143 as introductory text: |
142 as introductory text: |
144 http://www.nsnam.org/doxygen/index.html |
143 http://www.nsnam.org/doxygen/index.html |
|
144 |
|
145 If you want to re-generate this documentation, you can |
|
146 easily do so: |
|
147 |
|
148 - doc/architecture.pdf is generated from the architecture.tex |
|
149 file in http://code.nsnam.org/docs |
|
150 |
|
151 - the doxygen documentation is generated from the doc/doxygen.conf |
|
152 configuration file. The command "scons doc" will generate it |
|
153 as doc/html/index.html if you have installed the doxygen tools |
|
154 (see http://www.doxygen.org) |
145 |
155 |
146 6) Working with the development version of ns-3 |
156 6) Working with the development version of ns-3 |
147 ----------------------------------------------- |
157 ----------------------------------------------- |
148 |
158 |
149 If you want to download and use the development version |
159 If you want to download and use the development version |