README: document nosetests invocation
authorW. Trevor King <wking@tremily.us>
Mon, 19 Nov 2012 09:04:47 +0000 (04:04 -0500)
committerW. Trevor King <wking@tremily.us>
Mon, 19 Nov 2012 09:04:47 +0000 (04:04 -0500)
README

diff --git a/README b/README
index ce1c944db5f5fd383c96561213181c939f4ae5a0..dcf9932a583f662ad2c5d3b6d8f8388e1fdb6b27 100644 (file)
--- a/README
+++ b/README
@@ -63,14 +63,13 @@ See the tests in ``FFT_tools.py`` for simple examples.
 Testing
 =======
 
-Run internal unit tests with::
+Run internal unit tests using Nose_::
 
-    $ python -m FFT_tools
+    $ nosetests --with-doctest --doctest-tests -vv FFT_tools.py
 
 If you want to plot the test results (useful for debugging), you'll
-need to install matplotlib_.  Then run::
-
-    $ python -m FFT_tools --plot
+need to install matplotlib_ and set ``TEST_PLOTS`` to ``True`` in
+``FFT_tools.py`` before invoking Nose.
 
 Licence
 =======
@@ -91,4 +90,5 @@ Version 3`_ or greater.
    https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
 .. _Sphinx: http://sphinx-doc.org/
 .. _numpydoc: https://github.com/numpy/numpy/tree/master/doc/sphinxext
+.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt