| Davide Pesavento | 3bc8e19 | 2022-12-31 01:40:11 -0500 | [diff] [blame] | 1 | <div align="center"> |
| 2 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 3 | [<img alt height="65" src="docs/named_data_theme/static/ndn-logo.svg"/>](https://named-data.net/) |
| Davide Pesavento | 3bc8e19 | 2022-12-31 01:40:11 -0500 | [diff] [blame] | 4 | |
| Davide Pesavento | b7bfcb9 | 2022-05-22 23:55:23 -0400 | [diff] [blame] | 5 | # NFD: Named Data Networking Forwarding Daemon |
| Alexander Afanasyev | a141700 | 2014-01-21 20:29:55 -0800 | [diff] [blame] | 6 | |
| Davide Pesavento | 3bc8e19 | 2022-12-31 01:40:11 -0500 | [diff] [blame] | 7 | </div> |
| 8 | |
| Davide Pesavento | 13dae35 | 2021-08-13 15:40:54 -0400 | [diff] [blame] | 9 | [](https://github.com/named-data/NFD/actions/workflows/ci.yml) |
| 10 | [](https://github.com/named-data/NFD/actions/workflows/docs.yml) |
| Davide Pesavento | b7bfcb9 | 2022-05-22 23:55:23 -0400 | [diff] [blame] | 11 |  |
| Davide Pesavento | 13dae35 | 2021-08-13 15:40:54 -0400 | [diff] [blame] | 12 |  |
| Nick Gordon | 3257af2 | 2017-12-21 14:15:55 -0600 | [diff] [blame] | 13 | |
| Alexander Afanasyev | 0c3e93d | 2014-05-12 15:49:56 -0700 | [diff] [blame] | 14 | ## Overview |
| 15 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 16 | NFD is a network forwarder that implements and evolves together with the Named |
| 17 | Data Networking (NDN) [protocol](https://docs.named-data.net/NDN-packet-spec/). |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 18 | Since the initial public release in 2014, NFD has been a core component of the |
| 19 | [NDN Platform](https://named-data.net/codebase/platform/). |
| Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 20 | |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 21 | The main design goal of NFD is to support diverse experimentation of NDN technology. The |
| 22 | design emphasizes *modularity* and *extensibility* to allow easy experiments with new |
| 23 | protocol features, algorithms, new applications. We have not fully optimized the code for |
| 24 | performance. The intention is that performance optimizations are one type of experiments |
| 25 | that developers can conduct by trying out different data structures and different |
| 26 | algorithms; over time, better implementations may emerge within the same design framework. |
| 27 | |
| 28 | NFD will keep evolving in three aspects: improvement of the modularity framework, keeping |
| 29 | up with the NDN protocol spec, and addition of other new features. We hope to keep the |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 30 | modular framework stable and lean, allowing researchers to implement and experiment with |
| 31 | various features, some of which may eventually work into the protocol spec. |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 32 | |
| 33 | ## Documentation |
| 34 | |
| 35 | See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions. |
| 36 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 37 | Extensive documentation is available on NFD's [homepage](https://docs.named-data.net/NFD/). |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 38 | |
| 39 | ## Reporting bugs |
| 40 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 41 | Please submit any bug reports or feature requests to the |
| 42 | [NFD issue tracker](https://redmine.named-data.net/projects/nfd/issues). |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 43 | |
| 44 | ## Contributing |
| 45 | |
| 46 | NFD is developed by a community effort. Although the first release was mostly done by the |
| 47 | members of [NSF-sponsored NDN project team](https://named-data.net/project/participants/), |
| 48 | it already contains significant contributions from people outside the project team (see |
| 49 | [`AUTHORS.md`](AUTHORS.md)). We strongly encourage participation from all interested parties, |
| 50 | since broader community support is key for NDN to succeed as a new Internet architecture. |
| 51 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 52 | Contributions to NFD are greatly appreciated and can be made through our |
| 53 | [Gerrit code review site](https://gerrit.named-data.net/). |
| 54 | If you are new to the NDN software community, please read our |
| 55 | [Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) |
| 56 | and [`README-dev.md`](README-dev.md) to get started. |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 57 | |
| 58 | ## License |
| 59 | |
| Davide Pesavento | 39c67f6 | 2023-02-15 00:26:26 -0500 | [diff] [blame] | 60 | NFD is free software distributed under the GNU General Public License version 3. |
| 61 | See [`COPYING.md`](COPYING.md) for details. |