Blame - README.md - mini-ndn

blob: 9508779bae818b74cf5f5dd481f519f694974ff3 [file] [log] [blame] [view]

Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	1	# Mini-NDN
carlosmscabral	e3c810e	2013-02-25 18:15:40 -0300	[diff] [blame]	2
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	3	![Latest version](https://img.shields.io/github/v/tag/named-data/mini-ndn?label=Latest%20version)
				4	[![Docker](https://github.com/named-data/mini-ndn/actions/workflows/docker.yml/badge.svg)](https://github.com/named-data/mini-ndn/actions/workflows/docker.yml)
Nick Gordon	22642a3	2017-12-21 14:05:40 -0600	[diff] [blame]	5
ashu	4c85880	2015-04-15 11:28:07 -0500	[diff] [blame]	6	### What is Mini-NDN?
carlosmscabral	e3c810e	2013-02-25 18:15:40 -0300	[diff] [blame]	7
Vince Lehman	608a133	2015-07-14 17:47:49 -0500	[diff] [blame]	8	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]	9	research on the NDN platform based on [Mininet](https://github.com/mininet/mininet).
				10	Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	11	[NDN project](https://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]	12
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	13	Mini-NDN is free and open source software distributed under the GNU General Public License version 3.
				14	For more information about licensing details and limitations, please refer to [`COPYING.md`](COPYING.md).
carlosmscabral	e3c810e	2013-02-25 18:15:40 -0300	[diff] [blame]	15
Vince Lehman	4e7df5a	2015-07-21 11:55:49 -0500	[diff] [blame]	16	The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team.
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	17	For more details, please refer to [`AUTHORS.rst`](AUTHORS.rst).
Vince Lehman	608a133	2015-07-14 17:47:49 -0500	[diff] [blame]	18	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]	19	[Redmine site](https://redmine.named-data.net/projects/mini-ndn) and the
				20	[mini-ndn mailing list](https://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn).
				21
				22	Mini-NDN is open to contribution from the public.
				23	If you are new to the NDN software community and intend to contribute to the codebase, please read our
				24	[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md).
carlosmscabral	e3c810e	2013-02-25 18:15:40 -0300	[diff] [blame]	25
				26	### Documentation
				27
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	28	Please refer to <https://minindn.memphis.edu/> for installation, usage, and other documentation.
awlane	73add71	2024-08-12 21:49:00 -0500	[diff] [blame]	29	The documentation can also be built locally using:
Ashlesh Gawande	6c86e30	2019-09-17 22:27:05 -0500	[diff] [blame]	30
Davide Pesavento	82cc17a	2025-02-17 18:30:05 -0500	[diff] [blame]	31	```shell
				32	./docs/build.sh
				33	```
Ashlesh Gawande	6c86e30	2019-09-17 22:27:05 -0500	[diff] [blame]	34
				35	and is available under `docs/_build/html`.