File: index.rst

package info (click to toggle)
ns3 3.47-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 106,848 kB
  • sloc: cpp: 633,577; python: 15,491; ansic: 6,773; makefile: 1,959; sh: 1,021; pascal: 632; javascript: 167; perl: 102
file content (35 lines) | stat: -rw-r--r-- 1,074 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.. 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
   best-practices