enpaul/keyosk
1
0
Fork 0
mirror of https://github.com/enpaul/keyosk.git synced 2024-09-28 19:54:01 +00:00
Code Issues Projects Releases Wiki Activity

Update development documentation

Browse Source
This commit is contained in:
Ethan Paul 2020-02-18 23:07:48 -05:00
parent d199c5fb0b
commit caa31b2dc3
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -66,19 +66,16 @@ make docs SPHINX_FORMAT=<some other sphinx format>
## developing ## developing
This project requires [Poetry](https://python-poetry.org/docs/#installation) version
1.0 or newer.
```bash ```bash
# install poetry
pip3 install poetry --user --pre
# install pre-commit
pip3 install pre-commit --user
# install pre-commit hooks
pre-commit install
# create virtual environment from lockfile # create virtual environment from lockfile
poetry install poetry install
# run the tests and static analysis # install pre-commit hooks
poetry run pre-commit install
# run the automated tests
poetry run tox poetry run tox
``` ```