Gitiles
Code Review Sign In
gerrit.named-data.net / ndnSIM / NFD / 08b91c8d4e2b1b8f6132cd7d0ebe111245abfdf0 / . / README.md
blob: e603989861f5103f12f5e23542a661b0055dc03b [file] [log] [blame] [view]
Davide Pesavento08b91c82019-04-13 19:42:10 -0400[diff] [blame^]1# NFD - Named Data Networking Forwarding Daemon
Alexander Afanasyeva1417002014-01-21 20:29:55 -0800[diff] [blame]2
Davide Pesavento08b91c82019-04-13 19:42:10 -0400[diff] [blame^]3![Language](https://img.shields.io/badge/C%2B%2B-14-blue.svg)
Davide Pesaventocffb4e52016-09-12 20:03:08 +0200[diff] [blame]4[![Build Status](https://travis-ci.org/named-data/NFD.svg?branch=master)](https://travis-ci.org/named-data/NFD)
Davide Pesavento08b91c82019-04-13 19:42:10 -0400[diff] [blame^]5![Latest Version](https://img.shields.io/github/tag/named-data/NFD.svg?color=darkkhaki&label=latest%20version)
Nick Gordon3257af22017-12-21 14:15:55 -0600[diff] [blame]6
Alexander Afanasyev0c3e93d2014-05-12 15:49:56 -0700[diff] [blame]7## Overview
8
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]9NFD is a network forwarder that implements and evolves together with the Named Data
Davide Pesavento08b91c82019-04-13 19:42:10 -0400[diff] [blame^]10Networking (NDN) [protocol](https://named-data.net/doc/NDN-packet-spec/current/).
11Since the initial public release in 2014, NFD has been a core component of the
12[NDN Platform](https://named-data.net/codebase/platform/).
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600[diff] [blame]13
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]14The main design goal of NFD is to support diverse experimentation of NDN technology. The
15design emphasizes *modularity* and *extensibility* to allow easy experiments with new
16protocol features, algorithms, new applications. We have not fully optimized the code for
17performance. The intention is that performance optimizations are one type of experiments
18that developers can conduct by trying out different data structures and different
19algorithms; over time, better implementations may emerge within the same design framework.
20
21NFD will keep evolving in three aspects: improvement of the modularity framework, keeping
22up with the NDN protocol spec, and addition of other new features. We hope to keep the
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]23modular framework stable and lean, allowing researchers to implement and experiment with
24various features, some of which may eventually work into the protocol spec.
Davide Pesavento08b91c82019-04-13 19:42:10 -0400[diff] [blame^]25
26## Documentation
27
28See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions.
29
30Extensive documentation is available on NFD's [homepage](https://named-data.net/doc/NFD/).
31
32## Reporting bugs
33
34Bug reports and feedback are highly appreciated and can be submitted through the
35[NFD issue tracker](https://redmine.named-data.net/projects/nfd/issues) or the
36[ndn-interest mailing list](http://www.lists.cs.ucla.edu/mailman/listinfo/ndn-interest).
37
38## Contributing
39
40NFD is developed by a community effort. Although the first release was mostly done by the
41members of [NSF-sponsored NDN project team](https://named-data.net/project/participants/),
42it already contains significant contributions from people outside the project team (see
43[`AUTHORS.md`](AUTHORS.md)). We strongly encourage participation from all interested parties,
44since broader community support is key for NDN to succeed as a new Internet architecture.
45
46If you are new to the NDN software community, please read [`README-dev.md`](README-dev.md)
47and the [Contributor's Guide](CONTRIBUTING.md) to get started.
48
49## License
50
51NFD is an open and free software package licensed under the GPL version 3 and is the
52centerpiece of our committement to making NDN's core technology open and free to all
53Internet users and developers. For more information about the licensing details and
54limitations, refer to [`COPYING.md`](COPYING.md).