From caa31b2dc3de4aa4ff14ae78b7f47ad7702a8051 Mon Sep 17 00:00:00 2001 From: Ethan Paul Date: Tue, 18 Feb 2020 23:07:48 -0500 Subject: [PATCH] Update development documentation --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 462542c..820a0a1 100644 --- a/README.md +++ b/README.md @@ -66,19 +66,16 @@ make docs SPHINX_FORMAT= ## developing +This project requires [Poetry](https://python-poetry.org/docs/#installation) version +1.0 or newer. + ```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 poetry install -# run the tests and static analysis +# install pre-commit hooks +poetry run pre-commit install + +# run the automated tests poetry run tox ```