Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
siddhantgoel committed Nov 30, 2018
1 parent 12df119 commit 61114a6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ python:
- "3.6"

install:
- make install-deps
- make build
- make local

script:
- make test
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ install-deps:
build:
python setup.py build_ext --inplace

local: update-deps install-deps build
local: install-deps build

#
# Utils
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ Up-to-date documentation is available on `Read the Docs`_.
Development
-----------

Please make sure you have Python 3.4+ and pipenv_ installed.
Please make sure you have Python 3.4+ and `pip-tools`_ installed.

1. Git clone the repository -
:code:`git clone https://github.com/siddhantgoel/streaming-form-data`

2. Install the packages required for development -
:code:`pipenv install --dev`
:code:`make local`

3. That's basically it. You should now be able to run the test suite -
:code:`py.test`.


.. _pipenv: https://docs.pipenv.org/install/#installing-pipenv
.. _pip tools: https://github.com/jazzband/pip-tools
.. _Read the Docs: https://streaming-form-data.readthedocs.io/

0 comments on commit 61114a6

Please sign in to comment.