# HG changeset patch # User Jeff Hammel <jhammel@mozilla.com> # Date 1330734216 28800 # Node ID d5c3fdceb718a003a801e0078b0152630d968489 # Parent 4415ba355f25e134311212c9a67095c222a761a8 flush out tests section diff -r 4415ba355f25 -r d5c3fdceb718 README.txt --- a/README.txt Fri Mar 02 16:03:37 2012 -0800 +++ b/README.txt Fri Mar 02 16:23:36 2012 -0800 @@ -35,6 +35,14 @@ Running the Tests ----------------- +The +`tests directory <http://k0s.org/mozilla/hg/simpypi/file/tip/tests>`_ +contains +`doctests <http://docs.python.org/library/doctest.html>`_ and +the test-runner, +`test.py <http://k0s.org/mozilla/hg/simpypi/file/tip/tests/test.py>`_ . +These tests illustrate basic functionality and protect from +regressions if they are run before code is committed. ``tests-require.txt`` contains dependencies that should be installed to run the tests. `Paste <http://pythonpaste.org/>`_ @@ -44,6 +52,10 @@ `virtualenv <http://www.virtualenv.org/>`_ is used for isolating python environments. +To run the tests, do:: + + python test.py + TODO ----