| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 1 | # NFD - Named Data Networking Forwarding Daemon |
| Alexander Afanasyev | a141700 | 2014-01-21 20:29:55 -0800 | [diff] [blame] | 2 | |
| Davide Pesavento | 13dae35 | 2021-08-13 15:40:54 -0400 | [diff] [blame] | 3 | [](https://github.com/named-data/NFD/actions/workflows/ci.yml) |
| 4 | [](https://github.com/named-data/NFD/actions/workflows/docs.yml) |
| 5 |  |
| 6 |  |
| Nick Gordon | 3257af2 | 2017-12-21 14:15:55 -0600 | [diff] [blame] | 7 | |
| Alexander Afanasyev | 0c3e93d | 2014-05-12 15:49:56 -0700 | [diff] [blame] | 8 | ## Overview |
| 9 | |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 10 | NFD is a network forwarder that implements and evolves together with the Named Data |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 11 | Networking (NDN) [protocol](https://named-data.net/doc/NDN-packet-spec/current/). |
| 12 | Since the initial public release in 2014, NFD has been a core component of the |
| 13 | [NDN Platform](https://named-data.net/codebase/platform/). |
| Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 14 | |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 15 | The main design goal of NFD is to support diverse experimentation of NDN technology. The |
| 16 | design emphasizes *modularity* and *extensibility* to allow easy experiments with new |
| 17 | protocol features, algorithms, new applications. We have not fully optimized the code for |
| 18 | performance. The intention is that performance optimizations are one type of experiments |
| 19 | that developers can conduct by trying out different data structures and different |
| 20 | algorithms; over time, better implementations may emerge within the same design framework. |
| 21 | |
| 22 | NFD will keep evolving in three aspects: improvement of the modularity framework, keeping |
| 23 | 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] | 24 | modular framework stable and lean, allowing researchers to implement and experiment with |
| 25 | various features, some of which may eventually work into the protocol spec. |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 26 | |
| 27 | ## Documentation |
| 28 | |
| 29 | See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions. |
| 30 | |
| 31 | Extensive documentation is available on NFD's [homepage](https://named-data.net/doc/NFD/). |
| 32 | |
| 33 | ## Reporting bugs |
| 34 | |
| 35 | Bug reports and feedback are highly appreciated and can be submitted through the |
| 36 | [NFD issue tracker](https://redmine.named-data.net/projects/nfd/issues) or the |
| 37 | [ndn-interest mailing list](http://www.lists.cs.ucla.edu/mailman/listinfo/ndn-interest). |
| 38 | |
| 39 | ## Contributing |
| 40 | |
| 41 | NFD is developed by a community effort. Although the first release was mostly done by the |
| 42 | members of [NSF-sponsored NDN project team](https://named-data.net/project/participants/), |
| 43 | it already contains significant contributions from people outside the project team (see |
| 44 | [`AUTHORS.md`](AUTHORS.md)). We strongly encourage participation from all interested parties, |
| 45 | since broader community support is key for NDN to succeed as a new Internet architecture. |
| 46 | |
| 47 | If you are new to the NDN software community, please read [`README-dev.md`](README-dev.md) |
| Davide Pesavento | 1752159 | 2020-05-14 19:01:32 -0400 | [diff] [blame] | 48 | and the [Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md) |
| 49 | to get started. |
| Davide Pesavento | 08b91c8 | 2019-04-13 19:42:10 -0400 | [diff] [blame] | 50 | |
| 51 | ## License |
| 52 | |
| Davide Pesavento | 1752159 | 2020-05-14 19:01:32 -0400 | [diff] [blame] | 53 | NFD is a free and open-source software package licensed under the GPL version 3 and |
| 54 | is the centerpiece of our committement to making NDN's core technology free and open |
| 55 | to all Internet users and developers. For more information about licensing, refer to |
| 56 | [`COPYING.md`](COPYING.md). |