| 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 |
| 5 | used to implement various NDN applications. The library is currently being used as part of |
| 6 | the following projects: |
| 7 | |
| 8 | - `NFD - NDN Forwarding Daemon <https://github.com/named-data/NFD>`__ |
| 9 | - `NLSR - Named-data Link-State Routing |
| 10 | protocol <https://github.com/named-data/NLSR>`__ |
| 11 | - `repo-ng - Next generation of NDN |
| 12 | repository <https://github.com/named-data/repo-ng>`__ |
| 13 | - `ChronoChat - Multi-user NDN chat |
| 14 | application <https://github.com/named-data/ChronoChat>`__ |
| 15 | - `ChronoSync - Sync library for multiuser realtime applications for |
| 16 | NDN <https://github.com/named-data/ChronoSync>`__ |
| 17 | - `ndn-tlv-ping - Ping Application For |
| 18 | NDN <https://github.com/named-data/ndn-tlv-ping>`__ |
| 19 | - `ndn-traffic - Traffic Generator For |
| 20 | NDN <https://github.com/named-data/ndn-traffic>`__ |
| 21 | |
| 22 | Please submit any bugs or issues to the `ndn-cxx issue tracker |
| 23 | <http://redmine.named-data.net/projects/ndn-cxx/issues>`__. |
| 24 | |
| 25 | ndn-cxx Documentation |
| 26 | --------------------- |
| 27 | |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 28 | |
| 29 | .. toctree:: |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame^] | 30 | :hidden: |
| 31 | :maxdepth: 2 |
| 32 | |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 33 | RELEASE_NOTES |
| 34 | INSTALL |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 35 | examples |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 36 | tutorials/security-library |
| 37 | tutorials/utils-ndn-regex |
| 38 | tutorials/security-validator-config |
| 39 | manpages |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 40 | code-style |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame^] | 41 | |
| 42 | - `API documentation (doxygen) <doxygen/annotated.html>`_ |
| 43 | |
| 44 | - :doc:`ndn-cxx v0.1.0 Release Notes <RELEASE_NOTES>` |
| 45 | |
| 46 | - :doc:`Getting Started with ndn-cxx <INSTALL>` |
| 47 | |
| 48 | - :doc:`Tutorial Examples <examples>` |
| 49 | |
| 50 | - :doc:`tutorials/security-library` |
| 51 | |
| 52 | - :doc:`tutorials/utils-ndn-regex` |
| 53 | |
| 54 | - :doc:`tutorials/security-validator-config` |
| 55 | |
| 56 | - :doc:`manpages` |
| 57 | |
| 58 | Documentation for ndn-cxx contributors |
| 59 | ++++++++++++++++++++++++++++++++++++++ |
| 60 | |
| 61 | - :doc:`code-style` |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 62 | |
| 63 | License |
| 64 | ------- |
| 65 | |
| 66 | ndn-cxx is an open source project licensed under BSD license. For more |
| 67 | information about the license, refer to |
| 68 | `COPYING <https://github.com/named-data/ndn-cxx/blob/master/COPYING>`_. |
| 69 | |
| 70 | While the license does not require it, we really would appreciate it if |
| 71 | others would share their contributions to the library if they are |
| 72 | willing to do so under the same license. |