| ashu | 4c85880 | 2015-04-15 11:28:07 -0500 | [diff] [blame] | 1 | Mini-NDN |
| 2 | ======== |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 3 | |
| ashu | 4c85880 | 2015-04-15 11:28:07 -0500 | [diff] [blame] | 4 | ### What is Mini-NDN? |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 5 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 6 | Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and |
| 7 | research on the NDN platform. Mini-NDN is based on [Mini-CCNx](https://github.com/chesteve/mn-ccnx) |
| 8 | which is a fork of [Mininet](https://github.com/mininet/mininet). |
| 9 | Mini-NDN uses the [Named Data Networking Forwarding Daemon (NFD)](https://github.com/named-data/NFD) |
| 10 | and the [Named Data Link State Routing Protocol (NLSR)](https://github.com/named-data/NLSR) to |
| 11 | emulate an NDN network on a single system. |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 12 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 13 | Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all |
| 14 | users and developers. For more information about licensing details and limitations, |
| 15 | please refer to [COPYING.md](COPYING.md). |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 16 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 17 | Mini-NDN is developed by members of the NSF-sponsored NDN project team. For more details, |
| 18 | please refer to [AUTHORS.md](AUTHORS.md). |
| 19 | Bug reports and feedback are highly appreciated and can be made through our |
| 20 | [Redmine site](http://redmine.named-data.net/projects/mini-ndn). |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 21 | |
| 22 | ### Documentation |
| 23 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 24 | * [Installation](INSTALL.md) |
| 25 | * [Getting Started](docs/GETTING-STARTED.md) |
| 26 | * [Mini-NDN Edit](docs/GUI.md) |
| 27 | * [Running Experiments](docs/EXPERIMENTS.md) |
| 28 | * [Mini-NDN Redmine](http://redmine.named-data.net/projects/mini-ndn) |