add text

2011-11-05 12:41:28 -05:00 · 2011-11-05 12:41:28 -05:00 · 9459f7f004
parent 16e7b7554c
commit 9459f7f004
1 changed files with 31 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -0,0 +1,31 @@
+openstack-nose - Nose plugin for openstack style test output
+============================================================
+
+openstack-nose provides a nose plugin that allow's nosetests output to
+mimic the output of openstack's run_tests.py.
+
+Installation
+------------
+    pip install -e git+https://github.com/jkoelker/openstack-nose.git#egg=openstack.nose_plugin
+
+Usage
+-----
+
+The following options are availible:
+
+    --with-openstack      Enable plugin Openstack: Nova style output
+                          generator
+                          [NOSE_WITH_OPENSTACK]
+    --openstack-red=OPENSTACK_RED
+                          Colorize run times greater than value red.
+                          [NOSE_OPENSTACK_RED] or 1.0
+    --openstack-yellow=OPENSTACK_YELLOW
+                          Colorize run times greater than value yellow.
+                          [NOSE_OPENSTACK_RED] or 0.25
+    --openstack-show-elapsed
+                          Show the elaped runtime of tests.
+                          [NOSE_OPENSTACK_SHOW_ELAPSED]
+    --openstack-color     Colorize output. [NOSE_OPENSTACK_COLOR]
+    --openstack-num-slow=OPENSTACK_NUM_SLOW
+                          Number top slowest tests to report.
+                          [NOSE_OPENSTACK_NUM_SLOW]