docs: Prepare version 0.1.0 release notes
Change-Id: If3a00751ed5aef36b76c2af653f0fe7b71fc7efd
diff --git a/bin/minindn b/bin/minindn
index af4be4d..0b8af79 100755
--- a/bin/minindn
+++ b/bin/minindn
@@ -79,6 +79,8 @@
from ndn.nlsr import Nlsr, NlsrConfigGenerator
from ndn.nfd import Nfd
+VERSION_NUMBER = "0.1.0"
+
def printExperimentNames():
experimentNames = ExperimentManager.getExperimentNames()
@@ -86,6 +88,10 @@
for experiment in experimentNames:
print " %s" % experiment
+def printVersion(option, opt, value, parser):
+ print "Mini-NDN v%s" % VERSION_NUMBER
+ sys.exit()
+
def parse_args():
usage="""Usage: minindn [template_file] [ -t | --testbed ]
If no template_file is given, ndn_utils/default-topology.conf (given sample file)
@@ -122,6 +128,9 @@
parser.add_option("--no-cli", action="store_false", dest="isCliEnabled",
help="Run experiments and exit without showing the command line interface")
+ parser.add_option('--version', '-V', action='callback', callback=printVersion,
+ help='Displays version information')
+
(options, arg) = parser.parse_args()
testbed = options.testbed
diff --git a/docs/RELEASE-NOTES.md b/docs/RELEASE-NOTES.md
new file mode 100644
index 0000000..b367cda
--- /dev/null
+++ b/docs/RELEASE-NOTES.md
@@ -0,0 +1,32 @@
+Release Notes
+=============
+
+Mini-NDN version 0.1.0 (initial release)
+----------------------------------------
+
+Release date: July 15, 2015
+
+Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
+research on the NDN platform. Based on 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.
+
+**Included features**:
+
+- Run a complete NDN network on a single system
+
+- Automatic configuration of NLSR to provide a routable NDN network
+
+- Supports user created NDN applications
+
+- Create a topology using the included Mini-NDN Edit GUI application
+
+- Allows individual configuration of NFD and NLSR parameters for each node
+
+- Provides an experiment management framework for easy creation of custom networking experiments
+
+- Uses a simple topology file format to define hosts, links, and configuration values
+
+- Configure network link parameters including bandwidth, delay, and loss rate
+
+- Includes a pre-configured topology file to replicate the NDN testbed