Gitiles
Code Review Sign In
gerrit.named-data.net / NLSR / c1d0e8e34de10d5a5190734bdd7e3c6348852b1e / . / README.md
blob: 25cee7da222a546c183caccfc48d4a303819f05a [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)
Davide Pesaventoc1d0e8e2022-06-15 14:26:02 -0400[diff] [blame^]5![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
Davide Pesaventoba8a4ed2021-10-13 21:28:43 -0400[diff] [blame]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
akmhoquecc827532014-07-09 08:48:49 -0500[diff] [blame]11## Overview
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]12
Davide Pesaventof6be8e32020-04-30 16:06:03 -0400[diff] [blame]13NLSR is a routing protocol in NDN that populates NDN's Routing Information Base.
14NLSR will continue to evolve alongside the Named Data Networking
15[protocol](https://named-data.net/doc/NDN-packet-spec/current/).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]16
Davide Pesaventof6be8e32020-04-30 16:06:03 -0400[diff] [blame]17NLSR is an open and free software package licensed under the GPL 3.0 license and free to
18all Internet users and developers. For more information about the licensing details and
19limitations, refer to [`COPYING.md`](COPYING.md).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]20
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame]21NLSR 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]22For more details, please refer to [`AUTHORS.md`](AUTHORS.md).
23Bug reports and feedback are highly appreciated and can be made through our
24[Redmine site](https://redmine.named-data.net/projects/nlsr/issues).
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]25
Davide Pesaventof6be8e32020-04-30 16:06:03 -0400[diff] [blame]26The 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]27NLSR calculates the routing table using link-state or hyperbolic routing and produces
28multiple faces for each reachable name prefix in a single authoritative domain. NLSR
29will continue to evolve over time to include neighbor discovery and to become a full
30fledged inter-domain routing protocol for NDN.
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]31
Davide Pesaventof6be8e32020-04-30 16:06:03 -0400[diff] [blame]32## Source releases
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]33
Davide Pesaventoc1d0e8e2022-06-15 14:26:02 -0400[diff] [blame^]34The source code and installation instructions are available at the following locations:
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]35
Ashlesh Gawande39cf81a2018-02-22 13:37:07 -0600[diff] [blame]36- [Installation](https://named-data.net/doc/NLSR/current/INSTALL.html)
37- [Getting Started with NLSR](https://named-data.net/doc/NLSR/current/GETTING-STARTED.html)
Junxiao Shif09e2632015-01-02 18:15:01 -0700[diff] [blame]38- [GitHub NLSR repository](https://github.com/named-data/NLSR)
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]39
Davide Pesaventoc1d0e8e2022-06-15 14:26:02 -0400[diff] [blame^]40## Additional resources
akmhoquedbfd7912014-01-31 20:15:39 -0600[diff] [blame]41
Davide Pesaventof6be8e32020-04-30 16:06:03 -0400[diff] [blame]42- [Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md)
Davide Pesaventoc1d0e8e2022-06-15 14:26:02 -0400[diff] [blame^]43- [NLSR Wiki](https://redmine.named-data.net/projects/nlsr/wiki)
44- [NLSR Issue Tracker](https://redmine.named-data.net/projects/nlsr/issues)
Ashlesh Gawandeb4567f42017-04-28 14:40:39 -0500[diff] [blame]45- [NLSR Mailing List Sign Up](https://listserv.memphis.edu/scripts/wa.exe?GETPW1)
46- [NLSR Mailing List](https://listserv.memphis.edu/scripts/wa.exe?SUBED1=NLSR-HELP-L&A=1)
47- [NLSR Mailing List Archives](https://listserv.memphis.edu/scripts/wa.exe?A0=NLSR-HELP-L)
dmcoomesa47255c2017-09-29 16:08:32 -0500[diff] [blame]48- [NLSR Developer's guide](https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf)