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

ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
used to implement various NDN applications.

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

ndn-cxx Documentation
---------------------

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

   README
   INSTALL
   examples
   tutorials
   specs
   manpages

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

   code-style
   RELEASE_NOTES
   releases

- :doc:`README`

- :doc:`INSTALL`

- :doc:`examples`

- :doc:`tutorials`

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

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

- :doc:`specs`

   + :doc:`specs/signed-interest`
   + :doc:`specs/certificate-format`
   + :doc:`specs/safe-bag`
   + :doc:`specs/validation-error-code`

- :doc:`manpages`

**Additional documentation**

- `API documentation (doxygen) <doxygen/annotated.html>`_

- :doc:`code-style`

- :doc:`RELEASE_NOTES`

- :doc:`releases`

License
-------

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