| 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 | |
| Nick Gordon | 22642a3 | 2017-12-21 14:05:40 -0600 | [diff] [blame] | 4 | If you are new to the NDN community of software generally, read the |
| 5 | [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md). |
| 6 | |
| ashu | 4c85880 | 2015-04-15 11:28:07 -0500 | [diff] [blame] | 7 | ### What is Mini-NDN? |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 8 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 9 | Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 10 | research on the NDN platform based on [Mininet](https://github.com/mininet/mininet). |
| 11 | Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the |
| 12 | [NDN project](http://named-data.net/codebase/platform/) to emulate an NDN network on a single system. |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 13 | |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 14 | Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all |
| 15 | users and developers. For more information about licensing details and limitations, |
| 16 | please refer to [COPYING.md](COPYING.md). |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 17 | |
| Vince Lehman | 4e7df5a | 2015-07-21 11:55:49 -0500 | [diff] [blame] | 18 | The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team. |
| 19 | Mini-NDN is open to contribution from the public. |
| 20 | For more details, please refer to [AUTHORS.md](AUTHORS.md). |
| Vince Lehman | 608a133 | 2015-07-14 17:47:49 -0500 | [diff] [blame] | 21 | Bug reports and feedback are highly appreciated and can be made through our |
| Vince Lehman | 4e7df5a | 2015-07-21 11:55:49 -0500 | [diff] [blame] | 22 | [Redmine site](http://redmine.named-data.net/projects/mini-ndn) and the |
| 23 | [mini-ndn mailing list](http://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn). |
| carlosmscabral | e3c810e | 2013-02-25 18:15:40 -0300 | [diff] [blame] | 24 | |
| 25 | ### Documentation |
| 26 | |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 27 | Please refer to http://minindn.memphis.edu/ or [docs/index.rst](docs/index.rst) for installation, usage, and other documentation. |
| 28 | The documentation can be built using: |
| 29 | |
| 30 | ./install.sh -d |
| 31 | |
| 32 | and is available under `docs/_build/html`. |