Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / b6828918cd5ba3d7be144bb24e9d3082dc1d2b69 / . / docs / index.rst
blob: f9c73517b427b3eb56841034572a4ac222a9b905 [file] [log] [blame]
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]1ndn-cxx: NDN C++ library with eXperimental eXtensions
2=====================================================
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]3
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]4ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]5used to implement various NDN applications.
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]6
7Please submit any bugs or issues to the `ndn-cxx issue tracker
Davide Pesavento0530b5b2016-11-07 03:23:58 +0100[diff] [blame]8<https://redmine.named-data.net/projects/ndn-cxx/issues>`__.
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]9
10ndn-cxx Documentation
11---------------------
12
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]13.. toctree::
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]14 :hidden:
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]15 :maxdepth: 3
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]16
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]17 README
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]18 INSTALL
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]19 examples
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]20 tutorials
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]21 specs
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]22 manpages
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]23
24.. toctree::
25 :hidden:
26 :maxdepth: 1
27
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]28 code-style
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]29 RELEASE_NOTES
30 releases
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]31
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]32- :doc:`README`
33
34- :doc:`INSTALL`
35
36- :doc:`examples`
37
38- :doc:`tutorials`
39
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]40 + :doc:`tutorials/utils-ndn-regex`
41 + :doc:`tutorials/security-validator-config`
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]42
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 -0800[diff] [blame]48 + :doc:`specs/validation-error-code`
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]49
50- :doc:`manpages`
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]51
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]52**Additional documentation**
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]53
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]54- `API documentation (doxygen) <doxygen/annotated.html>`_
55
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]56- :doc:`code-style`
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]57
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]58- :doc:`RELEASE_NOTES`
59
60- :doc:`releases`
Alexander Afanasyev5946ed12015-01-19 23:41:39 -0800[diff] [blame]61
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]62License
63-------
64
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -0500[diff] [blame]65ndn-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>`_.