| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 1 | ndn-cxx: NDN C++ library with eXperimental eXtensions |
| 2 | ===================================================== |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 3 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -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 |
| 6 | of the following projects: |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 7 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [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 | * [repo-ng - Next generation of NDN repository](https://github.com/named-data/repo-ng) |
| 11 | * [ChronoChat - Multi-user NDN chat application](https://github.com/named-data/ChronoChat) |
| 12 | * [ChronoSync - Sync library for multiuser realtime applications for NDN](https://github.com/named-data/ChronoSync) |
| 13 | * [ndn-tlv-ping - Ping Application For NDN](https://github.com/named-data/ndn-tlv-ping) |
| Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 14 | * [ndn-traffic-generator - Traffic Generator For NDN](https://github.com/named-data/ndn-traffic-generator) |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 15 | |
| Alexander Afanasyev | abaab52 | 2014-04-30 20:42:11 -0700 | [diff] [blame] | 16 | See the file [`docs/INSTALL.rst`](https://github.com/cawka/ndn-cxx/blob/master/docs/INSTALL.rst) |
| Alexander Afanasyev | c5452c5 | 2014-04-29 17:21:51 -0700 | [diff] [blame] | 17 | for build and install instructions. |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 18 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 19 | Please submit any bugs or issues to the ndn-cxx issue tracker: |
| 20 | http://redmine.named-data.net/projects/ndn-cxx/issues |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 21 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 22 | ## More documentation |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 23 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 24 | Extensive documentation of the library is available on the library's homepage: |
| 25 | http://www.named-data.net/doc/ndn-cxx/ |
| 26 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 27 | ## License |
| 28 | |
| 29 | ndn-cxx is an open source project licensed under BSD license. For more information about |
| 30 | the license, refer to [`COPYING`](https://github.com/named-data/ndn-cxx/blob/master/COPYING). |
| 31 | |
| 32 | While the license does not require it, we really would appreciate it if others would share |
| 33 | their contributions to the library if they are willing to do so under the same license. |