changeset 78:d5c3fdceb718

flush out tests section
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 02 Mar 2012 16:23:36 -0800
parents 4415ba355f25
children f42df1456565
files README.txt
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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
 ----