From d7047e2d150771ae3ce0d1126494db0ec0cbf786 Mon Sep 17 00:00:00 2001 From: Kiarash Sotoudeh Date: Wed, 30 Oct 2024 02:56:57 -0400 Subject: [PATCH] Update README with poetry setup and contributing guidelines --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index be18f5327..76471b90a 100644 --- a/README.md +++ b/README.md @@ -53,29 +53,26 @@ below. ## 🧑🏿‍💻 Developing -### Using poetry +### Using Poetry The development environment can be set up using -[poetry](https://python-poetry.org/docs/#installation). Hence, make sure it is -installed and then run: +[Poetry](https://python-poetry.org/docs/#installation). Ensure Poetry is installed and then run: ```bash -python3 -m poetry install +poetry install source $(poetry env info --path)/bin/activate ``` -In order to install dependencies for testing (codestyle, unit tests, integration tests), -run: +To install dependencies for testing (codestyle, unit tests, integration tests), run: ```bash -python3 -m poetry install --with test +poetry install --with test ``` -API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and -can be locally built by: +API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and can be locally built by: ```bash -python3 -m poetry install --with docs +poetry install --with docs cd docs make html SPHINXOPTS="-D nbsphinx_allow_errors=True" ```