From: Thierry Parmentelat Date: Thu, 5 Nov 2015 09:30:48 +0000 (+0100) Subject: README moves to markdown X-Git-Tag: nepi-6.0.3-pypi~3 X-Git-Url: http://git.onelab.eu/?p=nepi.git;a=commitdiff_plain;h=7bdd35bc0d846e6ae89bdc8aaa2e919bbac25096 README moves to markdown --- diff --git a/README b/README deleted file mode 100644 index aede580a..00000000 --- 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 index 00000000..127121d9 --- /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. diff --git a/setup.py b/setup.py index 235743d5..728e04ee 100755 --- 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() -with open("README") as f: +with open("README.md") as f: 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 = [ ]