Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / 9b911e97c8ff7b87bb11f5293cf5b6377413dcb8 / . / docs / index.rst
blob: bd0ba18afdcda0a21e1f3b95a5be823e34a43933 [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 Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]4.. toctree::
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]5 :hidden:
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]6 :maxdepth: 3
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]7
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]8 INSTALL
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]9 examples
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]10 tutorials
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]11 specs
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]12 manpages
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]13
14.. toctree::
15 :hidden:
16 :maxdepth: 1
17
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]18 code-style
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]19 release-notes
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]20 releases
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]21
Davide Pesaventofcd3e442023-03-10 18:44:11 -0500[diff] [blame]22**ndn-cxx** is a C++17 library implementing Named Data Networking (NDN) primitives
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]23that can be used to write various NDN applications. The library is currently being
24used by the following projects:
25
26* `NFD - NDN Forwarding Daemon <https://github.com/named-data/NFD>`_
27* `NLSR - Named-data Link-State Routing protocol <https://github.com/named-data/NLSR>`_
28* `ndn-tools - Essential NDN command-line tools <https://github.com/named-data/ndn-tools>`_
29* `ndn-svs - State Vector Sync library <https://github.com/named-data/ndn-svs>`_
30* `PSync - Partial and full Sync library <https://github.com/named-data/PSync>`_
31* `ChronoSync - Sync library for distributed real-time applications (deprecated) <https://github.com/named-data/ChronoSync>`_
32* `NAC - Name-based Access Control library <https://github.com/named-data/name-based-access-control>`_
33* `NDNCERT - NDN certificate management protocol <https://github.com/named-data/ndncert>`_
34* `repo-ng - NDN repository implementation in C++ (deprecated) <https://github.com/named-data/repo-ng>`_
35* `ndn-traffic-generator - Simple NDN traffic generator <https://github.com/named-data/ndn-traffic-generator>`_
36
37Documentation
38-------------
39
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]40- :doc:`INSTALL`
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]41- :doc:`examples`
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]42- :doc:`tutorials`
43
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700[diff] [blame]44 + :doc:`tutorials/utils-ndn-regex`
45 + :doc:`tutorials/security-validator-config`
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]46
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]47- :doc:`manpages`
48- :doc:`release-notes`
49- :doc:`releases`
50
51For developers
52^^^^^^^^^^^^^^
53
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]54- `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]55 (guide for newcomers to the NDN community of software)
56
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]57- :doc:`specs`
58
Yingdi Yu55ea01a2015-07-21 22:42:17 -0700[diff] [blame]59 + :doc:`specs/safe-bag`
Davide Pesaventocad94b02021-04-09 21:23:03 -0400[diff] [blame]60 + :doc:`specs/signed-interest`
Junxiao Shifa2128d2015-06-29 16:41:25 -0700[diff] [blame]61
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]62- `API documentation (doxygen) <doxygen/annotated.html>`__
Alexander Afanasyevabaab522014-04-30 20:42:11 -0700[diff] [blame]63- :doc:`code-style`
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]64
65Issues
66------
67
Davide Pesavento02ed3322023-02-23 19:40:22 -0500[diff] [blame]68Please submit any bug reports or feature requests to the
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]69`ndn-cxx issue tracker <https://redmine.named-data.net/projects/ndn-cxx/issues>`__.
Alexander Afanasyev5946ed12015-01-19 23:41:39 -0800[diff] [blame]70
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700[diff] [blame]71License
72-------
73
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]74ndn-cxx is an open source project licensed under the LGPL version 3. For more information about
Davide Pesaventof3e84872024-03-15 15:30:06 -0400[diff] [blame]75the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`__
76and `COPYING.lesser <https://github.com/named-data/ndn-cxx/blob/master/COPYING.lesser>`__.