docs/index.rst

ndn-cxx: NDN C++ library with eXperimental eXtensions
=====================================================

.. toctree::
   :hidden:
   :maxdepth: 3

   INSTALL
   examples
   tutorials
   specs
   manpages

.. toctree::
   :hidden:
   :maxdepth: 1

   code-style
   release-notes
   releases

**ndn-cxx** is a C++17 library implementing Named Data Networking (NDN) primitives
that can be used to write various NDN applications. The library is currently being
used by the following projects:

* `NFD - NDN Forwarding Daemon <https://github.com/named-data/NFD>`_
* `NLSR - Named-data Link-State Routing protocol <https://github.com/named-data/NLSR>`_
* `ndn-tools - Essential NDN command-line tools <https://github.com/named-data/ndn-tools>`_
* `ndn-svs - State Vector Sync library <https://github.com/named-data/ndn-svs>`_
* `PSync - Partial and full Sync library <https://github.com/named-data/PSync>`_
* `ChronoSync - Sync library for distributed real-time applications (deprecated) <https://github.com/named-data/ChronoSync>`_
* `NAC - Name-based Access Control library <https://github.com/named-data/name-based-access-control>`_
* `NDNCERT - NDN certificate management protocol <https://github.com/named-data/ndncert>`_
* `repo-ng - NDN repository implementation in C++ (deprecated) <https://github.com/named-data/repo-ng>`_
* `ndn-traffic-generator - Simple NDN traffic generator <https://github.com/named-data/ndn-traffic-generator>`_

Documentation
-------------

- :doc:`INSTALL`
- :doc:`examples`
- :doc:`tutorials`

   + :doc:`tutorials/utils-ndn-regex`
   + :doc:`tutorials/security-validator-config`

- :doc:`manpages`
- :doc:`release-notes`
- :doc:`releases`

For developers
^^^^^^^^^^^^^^

- `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__
  (guide for newcomers to the NDN community of software)

- :doc:`specs`

   + :doc:`specs/safe-bag`
   + :doc:`specs/signed-interest`

- `API documentation (doxygen) <doxygen/annotated.html>`__
- :doc:`code-style`

Issues
------

Please submit any bug reports or feature requests to the
`ndn-cxx issue tracker <https://redmine.named-data.net/projects/ndn-cxx/issues>`__.

License
-------

ndn-cxx is an open source project licensed under the LGPL version 3. For more information about
the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`__
and `COPYING.lesser <https://github.com/named-data/ndn-cxx/blob/master/COPYING.lesser>`__.