| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 1 | ndn-cxx: NDN C++ library with eXperimental eXtensions |
| 2 | ===================================================== |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 3 | |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 4 | ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 5 | used to implement various NDN applications. |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 6 | |
| 7 | Please submit any bugs or issues to the `ndn-cxx issue tracker |
| Davide Pesavento | 0530b5b | 2016-11-07 03:23:58 +0100 | [diff] [blame] | 8 | <https://redmine.named-data.net/projects/ndn-cxx/issues>`__. |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 9 | |
| 10 | ndn-cxx Documentation |
| 11 | --------------------- |
| 12 | |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 13 | .. toctree:: |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 14 | :hidden: |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 15 | :maxdepth: 3 |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 16 | |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 17 | README |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 18 | INSTALL |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 19 | examples |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 20 | tutorials |
| Yingdi Yu | 55ea01a | 2015-07-21 22:42:17 -0700 | [diff] [blame] | 21 | specs |
| Junxiao Shi | fa2128d | 2015-06-29 16:41:25 -0700 | [diff] [blame] | 22 | manpages |
| Alexander Afanasyev | 45312f5 | 2015-09-27 12:06:50 -0700 | [diff] [blame] | 23 | |
| 24 | .. toctree:: |
| 25 | :hidden: |
| 26 | :maxdepth: 1 |
| 27 | |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 28 | code-style |
| Alexander Afanasyev | 45312f5 | 2015-09-27 12:06:50 -0700 | [diff] [blame] | 29 | RELEASE_NOTES |
| 30 | releases |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 31 | |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 32 | - :doc:`README` |
| 33 | |
| 34 | - :doc:`INSTALL` |
| 35 | |
| 36 | - :doc:`examples` |
| 37 | |
| 38 | - :doc:`tutorials` |
| 39 | |
| Nick Gordon | fe13f56 | 2017-12-21 14:12:37 -0600 | [diff] [blame] | 40 | + `NDN Software Contributor's Guide <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`__ (guide for newcomers to the NDN community of software generally) |
| 41 | |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 42 | + :doc:`tutorials/utils-ndn-regex` |
| 43 | + :doc:`tutorials/security-validator-config` |
| Yingdi Yu | 55ea01a | 2015-07-21 22:42:17 -0700 | [diff] [blame] | 44 | |
| 45 | - :doc:`specs` |
| 46 | |
| 47 | + :doc:`specs/signed-interest` |
| 48 | + :doc:`specs/certificate-format` |
| 49 | + :doc:`specs/safe-bag` |
| Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 50 | + :doc:`specs/validation-error-code` |
| Junxiao Shi | fa2128d | 2015-06-29 16:41:25 -0700 | [diff] [blame] | 51 | |
| 52 | - :doc:`manpages` |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 53 | |
| Alexander Afanasyev | 45312f5 | 2015-09-27 12:06:50 -0700 | [diff] [blame] | 54 | **Additional documentation** |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 55 | |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 56 | - `API documentation (doxygen) <doxygen/annotated.html>`_ |
| 57 | |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 58 | - :doc:`code-style` |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 59 | |
| Alexander Afanasyev | 45312f5 | 2015-09-27 12:06:50 -0700 | [diff] [blame] | 60 | - :doc:`RELEASE_NOTES` |
| 61 | |
| 62 | - :doc:`releases` |
| Alexander Afanasyev | 5946ed1 | 2015-01-19 23:41:39 -0800 | [diff] [blame] | 63 | |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 64 | License |
| 65 | ------- |
| 66 | |
| Alexander Afanasyev | a4ebb92 | 2014-08-18 15:55:35 -0500 | [diff] [blame] | 67 | ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about |
| 68 | the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`_. |