Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / 67bc114aa8a1dd64ce77af23ee29b0e1c87c8c5e / . / README.md
blob: e01e4b3333cb7ffed1871aafd8eed34528879f27 [file] [log] [blame] [view]
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]1<div align="center">
2
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]3[<img alt height="65" src="docs/named_data_theme/static/ndn-logo.svg"/>](https://named-data.net/)
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]4
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]5# ndn-cxx: NDN C++ library with eXperimental eXtensions
Jeff Thompson057d3182013-08-09 17:02:25 -0700[diff] [blame]6
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]7</div>
8
Davide Pesavento09d56622021-08-23 17:44:25 -0400[diff] [blame]9[![CI](https://github.com/named-data/ndn-cxx/actions/workflows/ci.yml/badge.svg)](https://github.com/named-data/ndn-cxx/actions/workflows/ci.yml)
10[![Docs](https://github.com/named-data/ndn-cxx/actions/workflows/docs.yml/badge.svg)](https://github.com/named-data/ndn-cxx/actions/workflows/docs.yml)
Davide Pesaventofcd3e442023-03-10 18:44:11 -0500[diff] [blame]11![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
Davide Pesavento09d56622021-08-23 17:44:25 -0400[diff] [blame]12![Latest version](https://img.shields.io/github/v/tag/named-data/ndn-cxx?label=Latest%20version)
Davide Pesaventoec2fe542016-09-17 02:56:14 +0200[diff] [blame]13
Davide Pesaventofcd3e442023-03-10 18:44:11 -0500[diff] [blame]14**ndn-cxx** is a C++17 library implementing Named Data Networking (NDN) primitives
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]15that can be used to write various NDN applications. The library is currently being
16used by the following projects:
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]17
Davide Pesavento81de5d92022-12-30 01:08:05 -0500[diff] [blame]18* [**NFD** - NDN Forwarding Daemon](https://github.com/named-data/NFD)
19* [**NLSR** - Named-data Link-State Routing protocol](https://github.com/named-data/NLSR)
20* [**ndn-tools** - Essential NDN command-line tools](https://github.com/named-data/ndn-tools)
21* [**ndn-svs** - State Vector Sync library](https://github.com/named-data/ndn-svs)
22* [**PSync** - Partial and full Sync library](https://github.com/named-data/PSync)
23* [**ChronoSync** - Sync library for distributed real-time applications *(deprecated)*](https://github.com/named-data/ChronoSync)
24* [**NAC** - Name-based Access Control library](https://github.com/named-data/name-based-access-control)
25* [**NDNCERT** - NDN certificate management protocol](https://github.com/named-data/ndncert)
26* [**repo-ng** - NDN repository implementation in C++ *(deprecated)*](https://github.com/named-data/repo-ng)
27* [**ndn-traffic-generator** - Simple NDN traffic generator](https://github.com/named-data/ndn-traffic-generator)
Jeff Thompson057d3182013-08-09 17:02:25 -0700[diff] [blame]28
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]29## Documentation
Jeff Thompson057d3182013-08-09 17:02:25 -0700[diff] [blame]30
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]31See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions.
Jeff Thompson057d3182013-08-09 17:02:25 -0700[diff] [blame]32
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]33Extensive documentation is available on the library's [homepage](https://docs.named-data.net/ndn-cxx/).
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]34
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]35## Reporting bugs
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700[diff] [blame]36
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]37Please submit any bug reports or feature requests to the
Davide Pesavento46b04a52019-03-28 21:36:35 -0400[diff] [blame]38[ndn-cxx issue tracker](https://redmine.named-data.net/projects/ndn-cxx/issues).
39
40## Contributing
41
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]42Contributions to ndn-cxx are greatly appreciated and can be made through our
43[Gerrit code review site](https://gerrit.named-data.net/).
44If you are new to the NDN software community, please read our
45[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
46and [`README-dev.md`](README-dev.md) to get started.
Nick Gordonfe13f562017-12-21 14:12:37 -0600[diff] [blame]47
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700[diff] [blame]48## License
49
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500[diff] [blame]50ndn-cxx is free software distributed under the GNU Lesser General Public License version 3.
51See [`COPYING.md`](COPYING.md) for details.