From 3299fc1e271fe3b137ebbb32cd9c7bfd8cce8ea4 Mon Sep 17 00:00:00 2001 From: Chris Markiewicz Date: Sun, 3 Dec 2023 14:54:38 -0500 Subject: [PATCH] MNT: Update README --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 77d6f5531..2043c1d22 100644 --- a/README.rst +++ b/README.rst @@ -123,6 +123,27 @@ For more information on previous releases, see the `release archive`_ or .. _release archive: https://github.com/nipy/NiBabel/releases .. _development changelog: https://nipy.org/nibabel/changelog.html +Testing +======= + +During development, we recommend using tox_ to run nibabel tests:: + + git clone https://github.com/nipy/nibabel.git + cd nibabel + tox + +To test an installed version of nibabel, install the test dependencies +and run pytest_:: + + pip install nibabel[test] + pytest --pyargs nibabel + +For more information, consult the `developer guidelines`_. + +.. _tox: https://tox.wiki +.. _pytest: https://docs.pytest.org +.. _developer guidelines: https://nipy.org/nibabel/devel/devguide.html + Mailing List ============