adafruit-mirror/circup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README to include warning about make check.

Browse source
This commit is contained in:
Nicholas H.Tollervey 2019-09-06 12:29:25 +01:00
parent b810f3c0bc
commit 0068c461f8
No known key found for this signature in database
GPG key ID: FD2A04F69841B6FA
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -137,12 +137,20 @@ Developer Setup
Clone the repository then make a virtualenv. From the root of the project,
install the requirements::
pip install -r ".[dev]"
pip install -e ".[dev]"
Run the test suite::
make check
.. warning::
Whenever you run ``make check``, to ensure the test suite starts from a
known clean state, all auto-generated assets are deleted. This includes
assets generated by running ``pip install -e ".[dev]"``, including the
``circup`` command itself. Simply re-run ``pip`` to re-generate the
assets.
There is a Makefile that helps with most of the common workflows associated
with development. Typing "make" on its own will list the options thus::