Skip to content

Commit

Permalink
Add Running Tests section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
hfaran committed Nov 21, 2014
1 parent 652a5a7 commit 0782319
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,12 @@ These dependencies can be satisfied by running `pip install -r requirements.txt`

* [tornado](http://www.tornadoweb.org/en/stable/)
* [jsonschema](https://python-jsonschema.readthedocs.org/en/latest/)


## Running Tests

```bash
sudo pip2 install tox
sudo pip3 install tox
sudo tox # Will run test matrix
```
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. contents::
:depth: 3
:depth: 3.0
..
Tornado-JSON
Expand Down Expand Up @@ -79,6 +79,15 @@ These dependencies can be satisfied by running
- `tornado <http://www.tornadoweb.org/en/stable/>`__
- `jsonschema <https://python-jsonschema.readthedocs.org/en/latest/>`__

Running Tests
-------------

.. code:: bash
sudo pip2 install tox
sudo pip3 install tox
sudo tox # Will run test matrix
.. |Build Status| image:: https://travis-ci.org/hfaran/Tornado-JSON.png?branch=master
:target: https://travis-ci.org/hfaran/Tornado-JSON
.. |PyPI version| image:: https://badge.fury.io/py/Tornado-JSON.png
Expand Down
8 changes: 4 additions & 4 deletions maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@

* Update README.rst

```$ pandoc -s -t rst --toc README.md -o README.rst```
```pandoc -s -t rst --toc README.md -o README.rst```

* Install project with files.txt record

```$ sudo python setup.py install --record files.txt```
```sudo python setup.py install --record files.txt```

* "uninstall" package installed with files.txt record

```$ cat files.txt | sudo xargs rm -rf```
```cat files.txt | sudo xargs rm -rf```

* Generate/update base docs/ folder with Sphinx

```$ sphinx-apidoc -F -o docs tornado_json```
```sphinx-apidoc -F -o docs tornado_json```

* Run tests from root project directory

Expand Down

0 comments on commit 0782319

Please sign in to comment.