Skip to content

Commit 25fe3d5

Browse files
committed
Add note in readme about flake8
1 parent 9fb60b7 commit 25fe3d5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ cd Yin-Yang
8989
./scripts/install.sh
9090
```
9191

92-
For development, skip the install and instead build python using Poetry. A virtual environment will be created for you:
92+
For development, skip the installation and instead build python using Poetry. A virtual environment will be created for you:
9393

9494
```bash
9595
# Load into virtual environment
@@ -100,6 +100,11 @@ poetry sync
100100
poetry run python -m yin_yang
101101
```
102102

103+
Make sure to run `flake8` on your files to avoid errors from the ci in PRs:
104+
```bash
105+
poetry run flake8
106+
```
107+
103108
### Uninstall
104109

105110
Run `scripts/uninstall.sh` from a terminal and fill out the password.

0 commit comments

Comments
 (0)