blob: f9c73517b427b3eb56841034572a4ac222a9b905 [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
Davide Pesavento0530b5b2016-11-07 03:23:58 +01008<https://redmine.named-data.net/projects/ndn-cxx/issues>`__.
Alexander Afanasyevc5452c52014-04-29 17:21:51 -07009
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
Yingdi Yu55ea01a2015-07-21 22:42:17 -070021 specs
Junxiao Shifa2128d2015-06-29 16:41:25 -070022 manpages
Alexander Afanasyev45312f52015-09-27 12:06:50 -070023
24.. toctree::
25 :hidden:
26 :maxdepth: 1
27
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070028 code-style
Alexander Afanasyev45312f52015-09-27 12:06:50 -070029 RELEASE_NOTES
30 releases
Alexander Afanasyevabaab522014-04-30 20:42:11 -070031
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070032- :doc:`README`
33
34- :doc:`INSTALL`
35
36- :doc:`examples`
37
38- :doc:`tutorials`
39
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070040 + :doc:`tutorials/utils-ndn-regex`
41 + :doc:`tutorials/security-validator-config`
Yingdi Yu55ea01a2015-07-21 22:42:17 -070042
43- :doc:`specs`
44
45 + :doc:`specs/signed-interest`
46 + :doc:`specs/certificate-format`
47 + :doc:`specs/safe-bag`
Alexander Afanasyev7e721412017-01-11 13:36:08 -080048 + :doc:`specs/validation-error-code`
Junxiao Shifa2128d2015-06-29 16:41:25 -070049
50- :doc:`manpages`
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070051
Alexander Afanasyev45312f52015-09-27 12:06:50 -070052**Additional documentation**
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070053
Alexander Afanasyevabaab522014-04-30 20:42:11 -070054- `API documentation (doxygen) <doxygen/annotated.html>`_
55
Alexander Afanasyevabaab522014-04-30 20:42:11 -070056- :doc:`code-style`
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070057
Alexander Afanasyev45312f52015-09-27 12:06:50 -070058- :doc:`RELEASE_NOTES`
59
60- :doc:`releases`
Alexander Afanasyev5946ed12015-01-19 23:41:39 -080061
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070062License
63-------
64
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -050065ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
66the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`_.