blob: 365736a8ea671c6e1c90a523f296fd85f5d50850 [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
Alexander Afanasyev766cea72014-04-24 19:16:42 -07004ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
5used to implement various NDN applications. The library is currently being used as part
6of the following projects:
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07007
Alexander Afanasyev766cea72014-04-24 19:16:42 -07008* [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 Afanasyev9b0e1142014-05-08 00:17:34 -070014* [ndn-traffic-generator - Traffic Generator For NDN](https://github.com/named-data/ndn-traffic-generator)
Jeff Thompson057d3182013-08-09 17:02:25 -070015
Alexander Afanasyevabaab522014-04-30 20:42:11 -070016See the file [`docs/INSTALL.rst`](https://github.com/cawka/ndn-cxx/blob/master/docs/INSTALL.rst)
Alexander Afanasyevc5452c52014-04-29 17:21:51 -070017for build and install instructions.
Jeff Thompson057d3182013-08-09 17:02:25 -070018
Alexander Afanasyev766cea72014-04-24 19:16:42 -070019Please submit any bugs or issues to the ndn-cxx issue tracker:
20http://redmine.named-data.net/projects/ndn-cxx/issues
Jeff Thompson057d3182013-08-09 17:02:25 -070021
Alexander Afanasyev766cea72014-04-24 19:16:42 -070022## More documentation
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070023
Alexander Afanasyev766cea72014-04-24 19:16:42 -070024Extensive documentation of the library is available on the library's homepage:
25http://www.named-data.net/doc/ndn-cxx/
26
Alexander Afanasyev766cea72014-04-24 19:16:42 -070027## License
28
Alexander Afanasyevc169a812014-05-20 20:37:29 -040029ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
Alexander Afanasyeva4ebb922014-08-18 15:55:35 -050030the license, refer to [`COPYING.md`](https://github.com/named-data/ndn-cxx/blob/master/COPYING.md).