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