summaryrefslogtreecommitdiffstats
path: root/robotframework-onap/README.TXT
diff options
context:
space:
mode:
Diffstat (limited to 'robotframework-onap/README.TXT')
-rw-r--r--robotframework-onap/README.TXT17
1 files changed, 15 insertions, 2 deletions
diff --git a/robotframework-onap/README.TXT b/robotframework-onap/README.TXT
index 9989546..f5b20c9 100644
--- a/robotframework-onap/README.TXT
+++ b/robotframework-onap/README.TXT
@@ -1,6 +1,19 @@
Robotframework-ONAP
=======================
-Robot framework plugin to work with onap
+Robot framework plugin to work with ONAP.
+It provides 3 packages:
-to install locally, checkout this repo and then run 'pip install -e .' in the root \ No newline at end of file
+* ONAPLibrary
+* vcpeutils
+
+A tox file has been created with the following targets:
+
+* py3: run unit tests using python3 + provide unit test coverage information
+* py27: run unit tests using python2.7
+* pep8: python linting with flake8 (python3)
+* pylint: python linting with pylint (python3), pylint provide a rate estimation
+
+You can run all the target one after the other by typing `tox` from
+robotframework-onap directory. Or if you want to specify a single target type
+`tox -epep8`