From 2a4f9a62fa7ec4631796a0eb27e1c468ebed27ca Mon Sep 17 00:00:00 2001 From: Nicholas Chammas Date: Tue, 15 Nov 2016 13:29:03 -0500 Subject: [PATCH] add note about how to run tests --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index 96a7f26..21a6163 100644 --- a/README.rst +++ b/README.rst @@ -64,3 +64,16 @@ Example Usage 'JALYF' >>> jellyfish.match_rating_codex(u'Jellyfish') 'JLLFSH' + +Running Tests +============= + +If you are interested in contributing to Jellyfish, you may want to +run tests locally. Jellyfish uses tox_ to run tests, which you can +setup and run as follows:: + + pip install tox + # cd jellyfish/ + tox + +.. _tox: https://tox.readthedocs.io/en/latest/