| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 1 | Introduction |
| Davide Pesavento | 82cc17a | 2025-02-17 18:30:05 -0500 | [diff] [blame^] | 2 | ============ |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 3 | |
| 4 | What is Mini-NDN? |
| 5 | ----------------- |
| 6 | |
| 7 | Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and |
| Davide Pesavento | 82cc17a | 2025-02-17 18:30:05 -0500 | [diff] [blame^] | 8 | research on the NDN platform. It was initially based on `Mini-CCNx <https://github.com/chesteve/mn-ccnx>`__ |
| 9 | which was a fork of `Mininet <https://github.com/mininet/mininet>`__. Mini-NDN uses the NDN libraries, |
| 10 | NFD, NLSR, and tools released by the `NDN project <https://named-data.net/codebase/platform/>`__ |
| 11 | to emulate an NDN network on a single system. |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 12 | |
| 13 | The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team. |
| 14 | Mini-NDN is open to contribution from the public. |
| 15 | |
| 16 | .. image:: minindnnet.svg |
| 17 | |
| 18 | License |
| 19 | _______ |
| 20 | |
| Davide Pesavento | 82cc17a | 2025-02-17 18:30:05 -0500 | [diff] [blame^] | 21 | Mini-NDN is free and open source software distributed under the GNU General Public License |
| 22 | version 3. For more information about licensing details and limitations, please refer to |
| 23 | `COPYING.md <https://github.com/named-data/mini-ndn/blob/master/COPYING.md>`__. |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 24 | |
| 25 | Feedback/Mailing List |
| 26 | _____________________ |
| 27 | |
| 28 | Bug reports and feedback are highly appreciated and can be made through our |
| Davide Pesavento | 82cc17a | 2025-02-17 18:30:05 -0500 | [diff] [blame^] | 29 | `Redmine site <https://redmine.named-data.net/projects/mini-ndn>`__ and the |
| 30 | `mini-ndn mailing list <https://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`__. |
| Ashlesh Gawande | 6c86e30 | 2019-09-17 22:27:05 -0500 | [diff] [blame] | 31 | |
| Davide Pesavento | 82cc17a | 2025-02-17 18:30:05 -0500 | [diff] [blame^] | 32 | If you are new to the NDN software community and intend to contribute to the codebase, please read our |
| 33 | `Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__. |