blob: fe19ad8fbe813d11f7c3397c54ec25175cd01516 [file] [log] [blame]
Ashlesh Gawande6c86e302019-09-17 22:27:05 -05001Introduction
2=================
3
4If 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
7What is Mini-NDN?
8-----------------
9
10Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
11research on the NDN platform. It was initially based on `Mini-CCNx <https://github.com/chesteve/mn-ccnx>`_ which was a fork of `Mininet <https://github.com/mininet/mininet>`_. Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the `NDN project <http://named-data.net/codebase/platform/>`_ to emulate an NDN network on a single system.
12
13The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team.
14Mini-NDN is open to contribution from the public.
15
16.. image:: minindnnet.svg
17
18License
19_______
20
21Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all
22users and developers. For more information about licensing details and limitations,
23please refer to COPYING.md.
24
25Feedback/Mailing List
26_____________________
27
28Bug reports and feedback are highly appreciated and can be made through our
29`Redmine site <http://redmine.named-data.net/projects/mini-ndn>`_ and the
30`mini-ndn mailing list <http://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`_.
31
32Video
33_____
34
35.. raw:: html
36
37 <div id="video-container" class="col-md-6 ">
38 <p>Mini-NDN (content maybe outdated)</p>
39 <iframe width="600" height="345" src="https://www.youtube.com/embed/UxHPqaUwefg" frameborder="0" allowfullscreen=""></iframe>
40 </div>