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