| 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 |
| 5 | Networking (NDN) `protocol <http://named-data.net/doc/ndn-tlv/>`__. After the initial |
| 6 | release, NFD will become a core component of the `NDN Platform |
| 7 | <http://named-data.net/codebase/platform/>`__ and will follow the same release cycle. |
| 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 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 16 | README |
| 17 | getting-started |
| 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 | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 21 | .. |
| 22 | INSTALL |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 23 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 24 | * :doc:`README` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 25 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 26 | * :doc:`getting-started` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 27 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 28 | * :doc:`FAQ` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 29 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 30 | * :doc:`manpages` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 31 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 32 | **Additional documentation** |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 33 | |
| 34 | * `NFD Wiki <http://redmine.named-data.net/projects/nfd/wiki>`_ |
| 35 | |
| 36 | + `NFD Management protocol <http://redmine.named-data.net/projects/nfd/wiki/Management>`_ |
| 37 | + `NFD Configuration file format <http://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`_ |
| Alexander Afanasyev | 284257b | 2014-04-11 14:16:51 -0700 | [diff] [blame] | 38 | |
| 39 | * `API documentation (doxygen) <doxygen/annotated.html>`_ |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 40 | |
| Alexander Afanasyev | 2618153 | 2014-05-07 23:38:51 -0700 | [diff] [blame^] | 41 | Downloading |
| 42 | ----------- |
| 43 | |
| 44 | * `Source code GitHub git repository <https://github.com/named-data/NFD>`_. |
| 45 | |
| 46 | * :ref:`MacPorts NDN repository <How to start using NDN MacPorts repository on OSX>` |
| 47 | |
| 48 | * :ref:`Ubuntu NDN PPA repository <How to start using NDN PPA repository on Ubuntu Linux>` |
| Beichuan Zhang | 55b8ed4 | 2014-04-26 22:25:44 -0700 | [diff] [blame] | 49 | |
| 50 | License |
| 51 | ------- |
| 52 | |
| 53 | NFD is an open and free software package licensed under GPL 3.0 license and is the |
| 54 | centerpiece of our committement to making NDN's core technology open and free to all |
| 55 | Internet users and developers. For more information about the licensing details and |
| 56 | limitation, refer to `COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`_. |