| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 1 | # ndn-cxx: NDN C++ library with eXperimental eXtensions |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 2 | |
| Davide Pesavento | 09d5662 | 2021-08-23 17:44:25 -0400 | [diff] [blame^] | 3 | [](https://github.com/named-data/ndn-cxx/actions/workflows/ci.yml) |
| 4 | [](https://github.com/named-data/ndn-cxx/actions/workflows/docs.yml) |
| 5 |  |
| 6 |  |
| Davide Pesavento | ec2fe54 | 2016-09-17 02:56:14 +0200 | [diff] [blame] | 7 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 8 | **ndn-cxx** is a C++14 library implementing Named Data Networking (NDN) primitives |
| 9 | that can be used to write various NDN applications. The library is currently being |
| 10 | used by the following projects: |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 11 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 12 | * [NFD - NDN Forwarding Daemon](https://github.com/named-data/NFD) |
| 13 | * [NLSR - Named-data Link-State Routing protocol](https://github.com/named-data/NLSR) |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 14 | * [ndn-tools - Essential NDN command-line tools](https://github.com/named-data/ndn-tools) |
| Davide Pesavento | ab7300b | 2020-04-09 00:51:41 -0400 | [diff] [blame] | 15 | * [repo-ng - Next generation NDN repository](https://github.com/named-data/repo-ng) |
| 16 | * [ChronoSync - Sync library for multi-user real-time applications](https://github.com/named-data/ChronoSync) |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 17 | * [PSync - Partial and full synchronization library](https://github.com/named-data/PSync) |
| 18 | * [ndn-traffic-generator - Traffic generator for NDN](https://github.com/named-data/ndn-traffic-generator) |
| 19 | * [NAC - Name-based Access Control](https://github.com/named-data/name-based-access-control) |
| 20 | * [NDNS - Domain Name Service for NDN](https://github.com/named-data/ndns) |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 21 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 22 | ## Documentation |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 23 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 24 | See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions. |
| Jeff Thompson | 057d318 | 2013-08-09 17:02:25 -0700 | [diff] [blame] | 25 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 26 | Extensive documentation is available on the library's [homepage](https://named-data.net/doc/ndn-cxx/). |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 27 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 28 | ## Reporting bugs |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 29 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 30 | Please submit any bugs or feature requests to the |
| 31 | [ndn-cxx issue tracker](https://redmine.named-data.net/projects/ndn-cxx/issues). |
| 32 | |
| 33 | ## Contributing |
| 34 | |
| Davide Pesavento | 78338c5 | 2020-04-20 23:00:02 -0400 | [diff] [blame] | 35 | We greatly appreciate contributions to the ndn-cxx code base. |
| 36 | If you are new to the NDN software community, please read the |
| 37 | [Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md) |
| 38 | to get started. |
| Nick Gordon | fe13f56 | 2017-12-21 14:12:37 -0600 | [diff] [blame] | 39 | |
| Alexander Afanasyev | 766cea7 | 2014-04-24 19:16:42 -0700 | [diff] [blame] | 40 | ## License |
| 41 | |
| Davide Pesavento | 46b04a5 | 2019-03-28 21:36:35 -0400 | [diff] [blame] | 42 | ndn-cxx is an open source project licensed under the LGPL version 3. |
| 43 | See [`COPYING.md`](COPYING.md) for more information. |