Gitiles
Code Review Sign In
gerrit.named-data.net / ndnSIM / ndn-cxx / 45312f55c386236b082318e816afd22bed0f5e45 / . / docs / index.rst
blob: fcfc52190a459887643dc8faafb428697ba08d79 [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
8<http://redmine.named-data.net/projects/ndn-cxx/issues>`__.
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
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]21 manpages
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame^]22
23.. toctree::
24 :hidden:
25 :maxdepth: 1
26
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]27 code-style
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame^]28 RELEASE_NOTES
29 releases
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]30
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]31- :doc:`README`
32
33- :doc:`INSTALL`
34
35- :doc:`examples`
36
37- :doc:`tutorials`
38
39 + :doc:`tutorials/security-library`
40 + :doc:`tutorials/utils-ndn-regex`
41 + :doc:`tutorials/security-validator-config`
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]42 + :doc:`tutorials/signed-interest`
Yingdi Yufba8a632015-06-08 22:25:54 -0700[diff] [blame]43 + :doc:`tutorials/certificate-format`
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]44
45- :doc:`manpages`
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]46
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame^]47**Additional documentation**
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]48
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]49- `API documentation (doxygen) <doxygen/annotated.html>`_
50
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]51- :doc:`code-style`
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]52
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame^]53- :doc:`RELEASE_NOTES`
54
55- :doc:`releases`
Alexander Afanasyev5946ed12015-01-19 23:41:39 -0800[diff] [blame]56
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]57License
58-------
59
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -0500[diff] [blame]60ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
61the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`_.