Gitiles
Code Review Sign In
gerrit.named-data.net / ndnSIM / 40ee381e32653ea0e9f103855920d3624521ae37 / . / docs / index.rst
blob: 45f126ad23af17f0992cb4615247f307c15cca5c [file] [log] [blame]
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]1NFD - Named Data Networking Forwarding Daemon
2=============================================
3
4NFD is a network forwarder that implements and evolves together with the Named Data
5Networking (NDN) `protocol <http://named-data.net/doc/ndn-tlv/>`__. After the initial
6release, 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 Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]9NFD Documentation
10-----------------
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]11
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]12.. toctree::
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]13 :hidden:
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]14 :maxdepth: 3
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]15
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]16 README
17 getting-started
18 FAQ
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]19 manpages
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]20
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]21..
22 INSTALL
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]23
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]24* :doc:`README`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]25
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]26* :doc:`getting-started`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]27
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]28* :doc:`FAQ`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]29
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]30* :doc:`manpages`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]31
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]32**Additional documentation**
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]33
Alexander Afanasyev40ee3812014-07-01 00:25:21 -0700[diff] [blame^]34* `NFD Developer's Guide <http://named-data.net/wp-content/uploads/2014/07/NFD-developer-guide.pdf>`_
35
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]36* `NFD Wiki <http://redmine.named-data.net/projects/nfd/wiki>`_
37
38 + `NFD Management protocol <http://redmine.named-data.net/projects/nfd/wiki/Management>`_
39 + `NFD Configuration file format <http://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`_
Alexander Afanasyev284257b2014-04-11 14:16:51 -0700[diff] [blame]40
41* `API documentation (doxygen) <doxygen/annotated.html>`_
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]42
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]43Downloading
44-----------
45
46* `Source code GitHub git repository <https://github.com/named-data/NFD>`_.
47
48* :ref:`MacPorts NDN repository <How to start using NDN MacPorts repository on OSX>`
49
50* :ref:`Ubuntu NDN PPA repository <How to start using NDN PPA repository on Ubuntu Linux>`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]51
52License
53-------
54
55NFD is an open and free software package licensed under GPL 3.0 license and is the
56centerpiece of our committement to making NDN's core technology open and free to all
57Internet users and developers. For more information about the licensing details and
58limitation, refer to `COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`_.