blob: bf20179441925c06bfa6ba4d7931d5ba132ac37d [file] [log] [blame] [view]
Alexander Afanasyev766cea72014-04-24 19:16:42 -07001ndn-cxx: NDN C++ library with eXperimental eXtensions
2=====================================================
Jeff Thompson057d3182013-08-09 17:02:25 -07003
Davide Pesaventoec2fe542016-09-17 02:56:14 +02004[![Build Status](https://travis-ci.org/named-data/ndn-cxx.svg?branch=master)](https://travis-ci.org/named-data/ndn-cxx)
5
Alexander Afanasyev766cea72014-04-24 19:16:42 -07006ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
Davide Pesavento0530b5b2016-11-07 03:23:58 +01007used to implement various NDN applications. The library is currently being used as part of
8the following projects:
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07009
Alexander Afanasyev766cea72014-04-24 19:16:42 -070010* [NFD - NDN Forwarding Daemon](https://github.com/named-data/NFD)
11* [NLSR - Named-data Link-State Routing protocol](https://github.com/named-data/NLSR)
12* [repo-ng - Next generation of NDN repository](https://github.com/named-data/repo-ng)
13* [ChronoChat - Multi-user NDN chat application](https://github.com/named-data/ChronoChat)
14* [ChronoSync - Sync library for multiuser realtime applications for NDN](https://github.com/named-data/ChronoSync)
Junxiao Shi6b872a92016-07-12 18:26:32 +000015* [ndn-tools - NDN Essential Tools](https://github.com/named-data/ndn-tools)
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070016* [ndn-traffic-generator - Traffic Generator For NDN](https://github.com/named-data/ndn-traffic-generator)
Jeff Thompson057d3182013-08-09 17:02:25 -070017
Davide Pesavento0530b5b2016-11-07 03:23:58 +010018See the file [`docs/INSTALL.rst`](https://github.com/named-data/ndn-cxx/blob/master/docs/INSTALL.rst)
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070019for build and install instructions.
Jeff Thompson057d3182013-08-09 17:02:25 -070020
Alexander Afanasyev766cea72014-04-24 19:16:42 -070021Please submit any bugs or issues to the ndn-cxx issue tracker:
Davide Pesavento0530b5b2016-11-07 03:23:58 +010022https://redmine.named-data.net/projects/ndn-cxx/issues
Jeff Thompson057d3182013-08-09 17:02:25 -070023
Alexander Afanasyev766cea72014-04-24 19:16:42 -070024## More documentation
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070025
Alexander Afanasyev766cea72014-04-24 19:16:42 -070026Extensive documentation of the library is available on the library's homepage:
27http://www.named-data.net/doc/ndn-cxx/
28
Alexander Afanasyev766cea72014-04-24 19:16:42 -070029## License
30
Alexander Afanasyevc169a812014-05-20 20:37:29 -040031ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -050032the license, refer to [`COPYING.md`](https://github.com/named-data/ndn-cxx/blob/master/COPYING.md).