| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 1 | NFD - Named Data Networking Forwarding Daemon |
| 2 | ============================================= |
| 3 | |
| 4 | NFD is a network forwarder that implements and evolves together with the Named Data |
| Eric Newberry | 81a9a86 | 2016-12-27 22:59:27 -0700 | [diff] [blame] | 5 | Networking (NDN) `protocol <https://named-data.net/doc/ndn-tlv/>`__. After the initial |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 6 | release, NFD will become a core component of the `NDN Platform |
| Eric Newberry | 81a9a86 | 2016-12-27 22:59:27 -0700 | [diff] [blame] | 7 | <https://named-data.net/codebase/platform/>`__ and will follow the same release cycle. |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 8 | |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 9 | NFD Documentation |
| 10 | ----------------- |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 11 | |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 12 | .. toctree:: |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 13 | :hidden: |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 14 | :maxdepth: 3 |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 15 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 16 | overview |
| 17 | INSTALL |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 18 | FAQ |
| Alexander Afanasyev | 49272f7 | 2014-04-06 21:49:46 -0700 | [diff] [blame] | 19 | manpages |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 20 | |
| Alexander Afanasyev | 687dba8 | 2015-09-27 15:32:58 -0700 | [diff] [blame] | 21 | .. toctree:: |
| 22 | :hidden: |
| 23 | :maxdepth: 1 |
| 24 | |
| 25 | RELEASE_NOTES |
| 26 | releases |
| 27 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 28 | * :doc:`overview` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 29 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 30 | A brief overview of NFD and its major modules. |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 31 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 32 | * :doc:`INSTALL` |
| 33 | |
| 34 | Instructions for obtaining, installing, and running NFD. |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 35 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 36 | * :doc:`FAQ` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 37 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 38 | Suggestions for configuring and running non-standard NFD setups. |
| 39 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 40 | * :doc:`manpages` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 41 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 42 | **Additional documentation** |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 43 | |
| Eric Newberry | 81a9a86 | 2016-12-27 22:59:27 -0700 | [diff] [blame] | 44 | * `NFD Developer's Guide <https://named-data.net/wp-content/uploads/2016/10/ndn-0021-7-nfd-developer-guide.pdf>`_ |
| Alexander Afanasyev | 40ee381 | 2014-07-01 00:25:21 -0700 | [diff] [blame] | 45 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 46 | A comprehensive guide to the design and implementation of NFD. The developer's guide also contains |
| 47 | suggestions and hints for anyone wanting to modify or extend NFD. |
| 48 | |
| Nick Gordon | 3257af2 | 2017-12-21 14:15:55 -0600 | [diff] [blame] | 49 | * `NDN Software Contributor's Guide |
| 50 | <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`__ |
| 51 | (guide for newcomers to the NDN community of software) |
| 52 | |
| Eric Newberry | 81a9a86 | 2016-12-27 22:59:27 -0700 | [diff] [blame] | 53 | * `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`_ |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 54 | |
| Eric Newberry | 81a9a86 | 2016-12-27 22:59:27 -0700 | [diff] [blame] | 55 | + `NFD Management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`_ |
| 56 | + `NFD Configuration file format <https://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`_ |
| Alexander Afanasyev | 284257b | 2014-04-11 14:16:51 -0700 | [diff] [blame] | 57 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 58 | The NFD Wiki contains detailed protocol specifications and |
| 59 | information for building on unsupported platforms. |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 60 | |
| Steve DiBenedetto | 62a9394 | 2014-08-24 17:13:52 -0600 | [diff] [blame] | 61 | * `API Documentation (doxygen) <doxygen/annotated.html>`_ |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame] | 62 | |
| Alexander Afanasyev | 687dba8 | 2015-09-27 15:32:58 -0700 | [diff] [blame] | 63 | * :doc:`RELEASE_NOTES` |
| 64 | |
| 65 | * :doc:`releases` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 66 | |
| 67 | License |
| 68 | ------- |
| 69 | |
| 70 | NFD is an open and free software package licensed under GPL 3.0 license and is the |
| 71 | centerpiece of our committement to making NDN's core technology open and free to all |
| 72 | Internet users and developers. For more information about the licensing details and |
| 73 | limitation, refer to `COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`_. |