Rooba
/
jellyfish
mirror of https://github.com/jamesturk/jellyfish.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add note about how to run tests

This commit is contained in:
Nicholas Chammas 2016-11-15 13:29:03 -05:00
parent c02c61c54c
commit 2a4f9a62fa
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.rst
View File

@ -64,3 +64,16 @@ Example Usage
'JALYF' 'JALYF'
>>> jellyfish.match_rating_codex(u'Jellyfish') >>> jellyfish.match_rating_codex(u'Jellyfish')
'JLLFSH' '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/