blob: cb21799835254801da2268eaa227a5ce2c3def70 [file] [log] [blame] [view]
Davide Pesavento4a160042020-04-13 16:50:02 -04001# repo-ng: Next generation NDN repository
Shuo Chen050fcad2014-03-12 15:45:54 -07002
Davide Pesavento4a160042020-04-13 16:50:02 -04003![Language](https://img.shields.io/badge/C%2B%2B-14-blue.svg)
Davide Pesavento3c29d632017-09-23 01:52:19 -04004[![Build Status](https://travis-ci.org/named-data/repo-ng.svg?branch=master)](https://travis-ci.org/named-data/repo-ng)
Shuo Chen050fcad2014-03-12 15:45:54 -07005
Davide Pesavento4a160042020-04-13 16:50:02 -04006**repo-ng** is an implementation of a Named Data Networking (NDN) data repository,
Davide Pesavento3c29d632017-09-23 01:52:19 -04007and follows the [Repo protocol](https://redmine.named-data.net/projects/repo-ng/wiki/Repo_Protocol_Specification).
Shuo Chen050fcad2014-03-12 15:45:54 -07008
Davide Pesavento4a160042020-04-13 16:50:02 -04009repo-ng uses [ndn-cxx](https://github.com/named-data/ndn-cxx) as the NDN development
10library, and [sqlite](https://www.sqlite.org/) as the underlying storage engine.
Davide Pesavento3c29d632017-09-23 01:52:19 -040011
Davide Pesavento4a160042020-04-13 16:50:02 -040012## Installation
Shuo Chen050fcad2014-03-12 15:45:54 -070013
Davide Pesavento4a160042020-04-13 16:50:02 -040014See [`INSTALL.md`](INSTALL.md) for build instructions.
Shuo Chen050fcad2014-03-12 15:45:54 -070015
Davide Pesavento4a160042020-04-13 16:50:02 -040016## Reporting bugs
17
18Please submit any bug reports or feature requests to the
Davide Pesavento3c29d632017-09-23 01:52:19 -040019[repo-ng issue tracker](https://redmine.named-data.net/projects/repo-ng/issues).
Davide Pesavento4a160042020-04-13 16:50:02 -040020
21## Contributing
22
23We greatly appreciate contributions to the repo-ng code base, provided that they are
24licensed under the GPL 3.0+ or a compatible license (see below).
25If you are new to the NDN software community, please read the
26[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md)
27to get started.
28
29## License
30
31ndn-tools is an open source project licensed under the GPL version 3.
32See [`COPYING.md`](COPYING.md) for more information.