Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Commit

Permalink
docs(README): Add note on dev setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Nokome Bentley committed Mar 13, 2020
1 parent 9d0c793 commit f5300e3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
all: setup clean lint format test build docs
all: lint format test build docs

setup:
pip3 install --user --upgrade -r requirements-dev.txt
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ must be named.

## Develop

### setup

To install the packages needed for development, run `make setup` or,

```bash
pip3 install --user --upgrade -r requirements-dev.txt
```

### Code formatting

We use [Black](https://github.com/psf/black) to maintain a consistent code formatting style. To run it use `black .` or `make format`.
Expand Down

0 comments on commit f5300e3

Please sign in to comment.