diff --git a/README.md b/README.md index c4fd79cc..63bd0499 100644 --- a/README.md +++ b/README.md @@ -27,29 +27,29 @@ $ conda install metalearners -c conda-forge The `metalearners` repository can be cloned as follows ```bash - $ git clone https://github.com/Quantco/metalearners.git +$ git clone https://github.com/Quantco/metalearners.git ``` The dependencies are managed via [pixi](https://pixi.sh/latest/). Please make sure to install `pixi` on your system. Once pixi is installed, you can install and run the pre-commit hooks as follows: ```bash - $ pixi run pre-commit-install - $ pixi run pre-commit-run +$ pixi run pre-commit-install +$ pixi run pre-commit-run ``` You can run the tests as follows: ```bash - $ pixi run postinstall - $ pixi run pytest tests +$ pixi run postinstall +$ pixi run pytest tests ``` You can build the documentation locally by running ```bash - $ pixi run -e docs postinstall - $ pixi run -e docs docs +$ pixi run -e docs postinstall +$ pixi run -e docs docs ``` You can then inspect the locally built docs by opening `docs/_build/index.html`.