.. only:: html or latex

ns-3 Installation Guide
=======================

This is the *ns-3 Installation 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/ns-3-dev/documentation/>`_:

  * Tutorial
  * Installation Guide *(this document)*
  * Manual
  * Model Library
  * Contributing Guide
* `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 <http://sphinx.pocoo.org/>`_ and is maintained in the ``doc/installation`` directory of ns-3's source code.  Source file column width is 100 columns.

.. toctree::
   :maxdepth: 2

   overview
   quick-start
   system
   linux
   macos
   windows
   bake