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
<http://redmine.named-data.net/projects/ndn-cxx/issues>`__.

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

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

   README
   INSTALL
   examples
   tutorials
   code-style

- :doc:`README`

- :doc:`INSTALL`

- :doc:`examples`

- :doc:`tutorials`

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

Documentation for ndn-cxx developers and contributors
+++++++++++++++++++++++++++++++++++++++++++++++++++++

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

- :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.