From 081fffd2e5e06d907eda71e19742b0c1668f77f0 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 19 Nov 2012 04:04:47 -0500 Subject: [PATCH] README: document nosetests invocation --- README | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README b/README index ce1c944..dcf9932 100644 --- 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 -- 2.26.2