| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 1 | NLSR - Named Data Link State Routing Protocol |
| 2 | ============================================= |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 3 | |
| Junxiao Shi | f09e263 | 2015-01-02 18:15:01 -0700 | [diff] [blame] | 4 | For complete documentation and more extensive information, |
| 5 | please visit the [NLSR homepage](http://named-data.net/doc/NLSR/current/). |
| 6 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 7 | ## Overview |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 8 | |
| Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 9 | NLSR is a routing protocol in NDN that populates NDN's Routing Information Base. NLSR |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 10 | will continue to evolve alongside the Named Data Networking [protocol](http://named-data.net/doc/ndn-tlv/). |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 11 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 12 | NLSR is an open and free software package licensed under the GPL 3.0 license and free to all |
| 13 | Internet users and developers. For more information about the licensing details and |
| 14 | limitations, refer to [COPYING.md](https://github.com/named-data/NLSR/blob/master/COPYING.md). |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 15 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 16 | NLSR is developed by the members of the [NSF-sponsored NDN project team](http://named-data.net/project/participants/). |
| 17 | For more details, please refer to [AUTHORS.md](https://github.com/named-data/NLSR/blob/master/AUTHORS.md). |
| 18 | Bug reports and feedback are highly appreciated and can be made through the |
| 19 | [Redmine site](http://redmine.named-data.net/projects/nlsr). |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 20 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 21 | The main design goal of NLSR is to provide a routing protocol to populate NDN's FIB. |
| 22 | NLSR calculates the routing table using link-state or hyperbolic routing and produces |
| 23 | multiple faces for each reachable name prefix in a single authoritative domain. NLSR |
| 24 | will continue to evolve over time to include neighbor discovery and to become a full |
| 25 | fledged inter-domain routing protocol for NDN. |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 26 | |
| 27 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 28 | Source releases |
| 29 | --------------- |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 30 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 31 | The source code and source-code installation instructions are always available at |
| 32 | the following links: |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 33 | |
| Junxiao Shi | f09e263 | 2015-01-02 18:15:01 -0700 | [diff] [blame] | 34 | - [Installation](http://named-data.net/doc/NLSR/current/INSTALL.html) |
| 35 | - [Getting Started with NLSR](http://named-data.net/doc/NLSR/current/GETTING-STARTED.html) |
| 36 | - [GitHub NLSR repository](https://github.com/named-data/NLSR) |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 37 | |
| dmcoomes | a47255c | 2017-09-29 16:08:32 -0500 | [diff] [blame^] | 38 | Currently, NLSR is not using the latest version of the ndn-cxx library. Therefore, it is |
| 39 | necessary to checkout the following versions of its dependencies: |
| 40 | |
| 41 | - ndn-cxx: b555b00c280b9c9ed46f24a1fbebc73b720601af |
| 42 | - NFD: f4056d0242536f85b7d7b4de1b5ac50dad65c233 |
| 43 | - Chronosync: 097bb448f46b8bd9a5c1f431e824f8f6a169b650 |
| 44 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 45 | Additional information |
| 46 | ---------------------- |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 47 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 48 | - [NLSR Wiki](http://redmine.named-data.net/projects/nlsr/wiki/) |
| 49 | - Feature requests and bug reports are welcome on our |
| 50 | [NLSR on NDN Redmine](http://redmine.named-data.net/projects/nlsr) |
| Ashlesh Gawande | b4567f4 | 2017-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) |
| dmcoomes | a47255c | 2017-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) |