blob: 2b6b09372814eb2c743475537f9272935bd12603 [file] [log] [blame]
NFD - Named Data Networking Forwarding Daemon
=============================================
NFD is a network forwarder that implements and evolves together with the Named Data
Networking (NDN) `protocol <https://named-data.net/doc/ndn-tlv/>`__. NFD is a core
component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.
NFD Documentation
-----------------
.. toctree::
:hidden:
:maxdepth: 3
overview
INSTALL
FAQ
manpages
.. toctree::
:hidden:
:maxdepth: 1
RELEASE_NOTES
releases
* :doc:`overview`
A brief overview of NFD and its major modules.
* :doc:`INSTALL`
Instructions for obtaining, installing, and running NFD.
* :doc:`FAQ`
Suggestions for configuring and running non-standard NFD setups.
* :doc:`manpages`
**Additional documentation**
* `NFD Developer's Guide <https://named-data.net/publications/techreports/ndn-0021-10-nfd-developer-guide/>`__
A comprehensive guide to the design and implementation of NFD. The developer's guide also contains
suggestions and hints for anyone wanting to modify or extend NFD.
* `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__
(guide for newcomers to the NDN community of software)
* `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`__
+ `NFD Management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
+ `NFD Configuration file format <https://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`__
The NFD Wiki contains detailed protocol specifications and
information for building on unsupported platforms.
* `API Documentation (doxygen) <doxygen/annotated.html>`__
* :doc:`RELEASE_NOTES`
* :doc:`releases`
License
-------
NFD is a free and open-source software package licensed under the GPL version 3 and
is the centerpiece of our committement to making NDN's core technology free and open
to all Internet users and developers. For more information about licensing, refer to
`COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`__.