blob: 7abaf35d9f5fd431d4977634257b3d3a28e9d8dd [file] [log] [blame]
Alexander Afanasyevc5452c52014-04-29 17:21:51 -07001ndn-cxx: NDN C++ library with eXperimental eXtensions
2=====================================================
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07003
Alexander Afanasyevc5452c52014-04-29 17:21:51 -07004ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -07005used to implement various NDN applications.
Alexander Afanasyevc5452c52014-04-29 17:21:51 -07006
7Please submit any bugs or issues to the `ndn-cxx issue tracker
8<http://redmine.named-data.net/projects/ndn-cxx/issues>`__.
9
10ndn-cxx Documentation
11---------------------
12
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070013.. toctree::
Alexander Afanasyevabaab522014-04-30 20:42:11 -070014 :hidden:
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070015 :maxdepth: 3
Alexander Afanasyevabaab522014-04-30 20:42:11 -070016
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070017 README
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070018 INSTALL
Alexander Afanasyev151a8552014-04-11 00:54:43 -070019 examples
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070020 tutorials
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070021 code-style
Alexander Afanasyevabaab522014-04-30 20:42:11 -070022
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070023- :doc:`README`
24
25- :doc:`INSTALL`
26
27- :doc:`examples`
28
29- :doc:`tutorials`
30
31 + :doc:`tutorials/security-library`
32 + :doc:`tutorials/utils-ndn-regex`
33 + :doc:`tutorials/security-validator-config`
34 + :doc:`manpages`
35
36Documentation for ndn-cxx developers and contributors
37+++++++++++++++++++++++++++++++++++++++++++++++++++++
38
Alexander Afanasyevabaab522014-04-30 20:42:11 -070039- `API documentation (doxygen) <doxygen/annotated.html>`_
40
Alexander Afanasyevabaab522014-04-30 20:42:11 -070041- :doc:`code-style`
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070042
43License
44-------
45
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -050046ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
47the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`_.