summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2016-10-13 11:04:12 -0500
committerMonty Taylor <mordred@inaugust.com>2016-10-13 11:25:33 -0500
commit968571920b33dc4b5190581abe6140945b49da6d (patch)
tree6f07526ff224ec5bc7afbc90dfd92ed0780d0dee /README.rst
parent644d93f4d632c302cc8cd8ef5c465acfa4e478d5 (diff)
A few structural cleanups
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst36
1 files changed, 24 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index 960bc5c..abab058 100644
--- a/README.rst
+++ b/README.rst
@@ -1,19 +1,31 @@
1=============================== 1=====
2ttrun 2ttrun
3=============================== 3=====
4 4
5Simple CLI to run testtools tests 5Simple CLI to run testtools tests
6 6
7Please fill here a long description which must be at least 3 lines wrapped on 7In a testrepository based workflow, sometimes you want/need to run individual
880 cols, so that distribution package maintainers can use it in their packages. 8tests outside of the construct of testtools. Additionally, someitmes you want
9Note that this is a hard requirement. 9to use a pre-existing tox virtualenv to do so. Or, at least, I do.
10 10
11* Free software: Apache license 11Typing:
12* Documentation: http://docs.openstack.org/developer/ttrun 12::
13* Source: http://git.openstack.org/cgit/openstack/ttrun
14* Bugs: http://bugs.launchpad.net/ttrun
15 13
16Features 14 .tox/py27/bin/python -m testtools.run some.test
17--------
18 15
19* TODO 16Got boring. So this is a simple wrapper.
17
18It has two modes:
19::
20
21 ttrun some.test
22
23Will run that test with the system python.
24
25If you want to re-use a tox virtualenv:
26::
27 ttrun -epy27 some.test
28
29Will run some.test in the given tox venv.
30
31Both modes can be run with no parameters to have testtools run all the tests.