Gitiles
Code Review Sign In
gerrit.named-data.net / NLSR / 39cf81a1107a44fc9dc7ce66904e9b8bc0d73977 / . / README.md
blob: b9ca24061f152f929ccad5fd03ea16223feb2275 [file] [log] [blame] [view]
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]1NLSR - Named Data Link State Routing Protocol
2=============================================
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]3
Junxiao Shif09e2632015-01-02 18:15:01 -0700[diff] [blame]4For complete documentation and more extensive information,
5please visit the [NLSR homepage](http://named-data.net/doc/NLSR/current/).
6
Nick Gordoned473c62017-12-21 14:02:30 -0600[diff] [blame]7If you are new to the NDN community of software generally, read the
8[Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md).
9
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]10## Overview
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]11
Alexander Afanasyev7decbbf2014-08-24 21:29:01 -0700[diff] [blame]12NLSR is a routing protocol in NDN that populates NDN's Routing Information Base. NLSR
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]13will continue to evolve alongside the Named Data Networking [protocol](http://named-data.net/doc/ndn-tlv/).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]14
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]15NLSR is an open and free software package licensed under the GPL 3.0 license and free to all
16Internet users and developers. For more information about the licensing details and
17limitations, refer to [COPYING.md](https://github.com/named-data/NLSR/blob/master/COPYING.md).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]18
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame^]19NLSR is developed by the members of the [NSF-sponsored NDN project team](https://named-data.net/project/participants/).
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]20For more details, please refer to [AUTHORS.md](https://github.com/named-data/NLSR/blob/master/AUTHORS.md).
21Bug reports and feedback are highly appreciated and can be made through the
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame^]22[Redmine site](https://redmine.named-data.net/projects/nlsr).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]23
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]24The main design goal of NLSR is to provide a routing protocol to populate NDN's FIB.
25NLSR calculates the routing table using link-state or hyperbolic routing and produces
26multiple faces for each reachable name prefix in a single authoritative domain. NLSR
27will continue to evolve over time to include neighbor discovery and to become a full
28fledged inter-domain routing protocol for NDN.
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]29
30
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]31Source releases
32---------------
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]33
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]34The source code and source-code installation instructions are always available at
35the following links:
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]36
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame^]37- [Installation](https://named-data.net/doc/NLSR/current/INSTALL.html)
38- [Getting Started with NLSR](https://named-data.net/doc/NLSR/current/GETTING-STARTED.html)
Junxiao Shif09e2632015-01-02 18:15:01 -0700[diff] [blame]39- [GitHub NLSR repository](https://github.com/named-data/NLSR)
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]40
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]41Additional information
42----------------------
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]43
Nick Gordoned473c62017-12-21 14:02:30 -0600[diff] [blame]44- [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md)
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame^]45- [NLSR Wiki](https://redmine.named-data.net/projects/nlsr/wiki/)
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]46- Feature requests and bug reports are welcome on our
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame^]47 [NLSR on NDN Redmine](https://redmine.named-data.net/projects/nlsr)
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]48- [NLSR Mailing List Sign Up](https://listserv.memphis.edu/scripts/wa.exe?GETPW1)
49- [NLSR Mailing List](https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1)
50- [NLSR Mailing List Archives](https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L)
dmcoomesa47255c2017-09-29 16:08:32 -0500[diff] [blame]51- [NLSR Developer's guide](https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf)