README moves to markdown
authorThierry Parmentelat <thierry.parmentelat@inria.fr>
Thu, 5 Nov 2015 09:30:48 +0000 (10:30 +0100)
committerThierry Parmentelat <thierry.parmentelat@inria.fr>
Thu, 5 Nov 2015 13:39:08 +0000 (14:39 +0100)
README [deleted file]
README.md [new file with mode: 0644]
setup.py

diff --git a/README b/README
deleted file mode 100644 (file)
index aede580..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-NEPI is a Python-based library to model and run network experiments on a variety of network evaluation platforms, including PlanetLab, OMF wireless testbeds, ns-3 simulators, and others. It allows to specify resources to use in an experiment, to define experiment workflow constraints and to automate deployment, resource control and result collection.       
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..127121d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# NEPI
+
+NEPI is a python-based library to model and run network experiments on a variety of network evaluation platforms, including 
+
+ * PlanetLab
+ * OMF wireless testbeds
+ * ns-3 simulators. 
+
+ It allows to specify resources to use in an experiment, to define experiment workflow constraints and to automate deployment, resource control and result collection.
+ Starting with nepi6, both python2 and python3 are supported.
index 235743d..728e04e 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -9,10 +9,11 @@ with open('VERSION') as f:
     version_tag = f.read().strip()
 with open("COPYING") as f:
     license = f.read()
     version_tag = f.read().strip()
 with open("COPYING") as f:
     license = f.read()
-with open("README") as f:
+with open("README.md") as f:
     long_description = f.read()
 
     long_description = f.read()
 
-data_files = [ ('/etc/nepi', [ 'VERSION', 'COPYING', 'README' ] ) ]
+# we'd probably would be better off with this some place else
+data_files = [ ('/etc/nepi', [ 'COPYING', 'README.md' ] ) ]
 
 ### requirements - used by pip install
 required_modules = [ ]
 
 ### requirements - used by pip install
 required_modules = [ ]