| 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 |
| 8 | <http://redmine.named-data.net/projects/ndn-cxx/issues>`__. |
| 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 |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 21 | code-style |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 22 | |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 23 | - :doc:`README` |
| 24 | |
| 25 | - :doc:`INSTALL` |
| 26 | |
| 27 | - :doc:`examples` |
| 28 | |
| 29 | - :doc:`tutorials` |
| 30 | |
| 31 | + :doc:`tutorials/security-library` |
| 32 | + :doc:`tutorials/utils-ndn-regex` |
| 33 | + :doc:`tutorials/security-validator-config` |
| 34 | + :doc:`manpages` |
| 35 | |
| 36 | Documentation for ndn-cxx developers and contributors |
| 37 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 38 | |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 39 | - `API documentation (doxygen) <doxygen/annotated.html>`_ |
| 40 | |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 41 | - :doc:`code-style` |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 42 | |
| 43 | License |
| 44 | ------- |
| 45 | |
| 46 | ndn-cxx is an open source project licensed under BSD license. For more |
| 47 | information about the license, refer to |
| 48 | `COPYING <https://github.com/named-data/ndn-cxx/blob/master/COPYING>`_. |
| 49 | |
| 50 | While the license does not require it, we really would appreciate it if |
| 51 | others would share their contributions to the library if they are |
| 52 | willing to do so under the same license. |