| 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 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 4 | ## Overview |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 5 | |
| Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 6 | 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] | 7 | 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] | 8 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 9 | NLSR is an open and free software package licensed under the GPL 3.0 license and free to all |
| 10 | Internet users and developers. For more information about the licensing details and |
| 11 | 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] | 12 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 13 | NLSR is developed by the members of the [NSF-sponsored NDN project team](http://named-data.net/project/participants/). |
| 14 | For more details, please refer to [AUTHORS.md](https://github.com/named-data/NLSR/blob/master/AUTHORS.md). |
| 15 | Bug reports and feedback are highly appreciated and can be made through the |
| 16 | [Redmine site](http://redmine.named-data.net/projects/nlsr). |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 17 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 18 | The main design goal of NLSR is to provide a routing protocol to populate NDN's FIB. |
| 19 | NLSR calculates the routing table using link-state or hyperbolic routing and produces |
| 20 | multiple faces for each reachable name prefix in a single authoritative domain. NLSR |
| 21 | will continue to evolve over time to include neighbor discovery and to become a full |
| 22 | fledged inter-domain routing protocol for NDN. |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 23 | |
| 24 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 25 | Source releases |
| 26 | --------------- |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 27 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 28 | The source code and source-code installation instructions are always available at |
| 29 | the following links: |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 30 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 31 | - [Installation](https://github.com/named-data/NLSR/blob/master/docs/INSTALL.md) |
| 32 | - [Getting Started with NLSR](https://github.com/named-data/NLSR/blob/master/docs/GETTING-STARTED.md) |
| 33 | - [Github NLSR repository](https://github.com/named-data/NLSR) |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 34 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 35 | Additional information |
| 36 | ---------------------- |
| akmhoque | dbfd791 | 2014-01-31 20:15:39 -0600 | [diff] [blame] | 37 | |
| akmhoque | cc82753 | 2014-07-09 08:48:49 -0500 | [diff] [blame] | 38 | - [NLSR Wiki](http://redmine.named-data.net/projects/nlsr/wiki/) |
| 39 | - Feature requests and bug reports are welcome on our |
| 40 | [NLSR on NDN Redmine](http://redmine.named-data.net/projects/nlsr) |