35 lines
1.0 KiB
ReStructuredText
35 lines
1.0 KiB
ReStructuredText
.. only:: html or latex
|
|
|
|
Contributing to ns-3
|
|
====================
|
|
|
|
This is the *ns-3 Contributing Guide*. Primary documentation for the ns-3 project is organized as
|
|
follows:
|
|
|
|
* Several guides that are version controlled for each release (the
|
|
`latest release <https://www.nsnam.org/documentation/latest/>`_) and
|
|
`development tree <https://www.nsnam.org/documentation/development-tree/>`_:
|
|
|
|
* Tutorial
|
|
* Installation Guide
|
|
* Manual
|
|
* Model Library
|
|
* Contributing Guide *(this document)*
|
|
* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
|
|
the simulator
|
|
* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
|
|
|
|
This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
|
|
``doc/contributing`` directory of ns-3's source code. Source file column width is 100 columns.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:numbered:
|
|
|
|
introduction
|
|
general
|
|
enhancements
|
|
models
|
|
external
|
|
coding-style
|