diff --git a/README.md b/README.md index eaf23c3f..b509ec9a 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Following initiative from the author of Material for MkDocs, this plugin provide Clone the repository: -```bash +```sh # install development dependencies python -m pip install -U -r requirements/development.txt # alternatively: pip install -e .[dev] @@ -77,18 +77,33 @@ python -m pip install -e . # install git hooks pre-commit install +``` + +Then follow the [contribution guidelines](CONTRIBUTING.md). + +### Run the tests + +```sh +# install development dependencies +python -m pip install -U -r requirements/testing.txt +# alternatively: pip install -e .[test] # run tests pytest +``` + +### Build the documentation +```sh # install dependencies for documentation python -m pip install -U -r requirements/documentation.txt # alternatively: pip install -e .[doc] -``` -Then follow the [contribution guidelines](CONTRIBUTING.md). +# build the documentation +mkdocs build +``` -## Release workflow +### Release workflow 1. Fill the `CHANGELOG.md` 1. Change the version number in `__about__.py`