| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 1 | # repo-ng: Next generation NDN repository |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 2 | |
| Davide Pesavento | 333e3eb | 2021-10-12 19:30:51 -0400 | [diff] [blame] | 3 | [](https://github.com/named-data/repo-ng/actions/workflows/ci.yml) |
| Davide Pesavento | 1190406 | 2022-04-14 22:33:28 -0400 | [diff] [blame] | 4 |  |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 5 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 6 | **repo-ng** is an implementation of a Named Data Networking (NDN) data repository, |
| Davide Pesavento | 3c29d63 | 2017-09-23 01:52:19 -0400 | [diff] [blame] | 7 | and follows the [Repo protocol](https://redmine.named-data.net/projects/repo-ng/wiki/Repo_Protocol_Specification). |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 8 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 9 | repo-ng uses [ndn-cxx](https://github.com/named-data/ndn-cxx) as the NDN development |
| Davide Pesavento | 1190406 | 2022-04-14 22:33:28 -0400 | [diff] [blame] | 10 | library and [sqlite](https://www.sqlite.org/) as the underlying storage engine. |
| Davide Pesavento | 3c29d63 | 2017-09-23 01:52:19 -0400 | [diff] [blame] | 11 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 12 | ## Installation |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 13 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 14 | See [`INSTALL.md`](INSTALL.md) for build instructions. |
| Shuo Chen | 050fcad | 2014-03-12 15:45:54 -0700 | [diff] [blame] | 15 | |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 16 | ## Reporting bugs |
| 17 | |
| 18 | Please submit any bug reports or feature requests to the |
| Davide Pesavento | 3c29d63 | 2017-09-23 01:52:19 -0400 | [diff] [blame] | 19 | [repo-ng issue tracker](https://redmine.named-data.net/projects/repo-ng/issues). |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 20 | |
| 21 | ## Contributing |
| 22 | |
| 23 | We greatly appreciate contributions to the repo-ng code base, provided that they are |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame] | 24 | licensed under the GNU GPL version 3 or a compatible license. |
| 25 | If you are new to the NDN software community, please read our [Contributor's Guide]( |
| 26 | https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) to get started. |
| Davide Pesavento | 4a16004 | 2020-04-13 16:50:02 -0400 | [diff] [blame] | 27 | |
| 28 | ## License |
| 29 | |
| Davide Pesavento | e9b09b8 | 2023-01-19 13:30:07 -0500 | [diff] [blame] | 30 | repo-ng is free software distributed under the GNU General Public License version 3. |
| 31 | See [`COPYING.md`](COPYING.md) for details. |