docs/index.rst

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. The library is currently being used as part of
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>`__
-  `repo-ng - Next generation of NDN
   repository <https://github.com/named-data/repo-ng>`__
-  `ChronoChat - Multi-user NDN chat
   application <https://github.com/named-data/ChronoChat>`__
-  `ChronoSync - Sync library for multiuser realtime applications for
   NDN <https://github.com/named-data/ChronoSync>`__
-  `ndn-tlv-ping - Ping Application For
   NDN <https://github.com/named-data/ndn-tlv-ping>`__
-  `ndn-traffic - Traffic Generator For
   NDN <https://github.com/named-data/ndn-traffic>`__

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

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


.. toctree::
   :hidden:
   :maxdepth: 2

   RELEASE_NOTES
   INSTALL
   examples
   tutorials/security-library
   tutorials/utils-ndn-regex
   tutorials/security-validator-config
   manpages
   code-style

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

- :doc:`ndn-cxx v0.1.0 Release Notes <RELEASE_NOTES>`

- :doc:`Getting Started with ndn-cxx <INSTALL>`

- :doc:`Tutorial Examples <examples>`

- :doc:`tutorials/security-library`

- :doc:`tutorials/utils-ndn-regex`

- :doc:`tutorials/security-validator-config`

- :doc:`manpages`

Documentation for ndn-cxx contributors
++++++++++++++++++++++++++++++++++++++

- :doc:`code-style`

License
-------

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

While the license does not require it, we really would appreciate it if
others would share their contributions to the library if they are
willing to do so under the same license.