Skip to content

Commit

Permalink
Add instruction to install shell plugin to doc (#1674)
Browse files Browse the repository at this point in the history
More context [here](#1673) 

Wanted to keep it as short as possible
@kevinjqliu
  • Loading branch information
gabeiglio authored Feb 18, 2025
1 parent d26d1e4 commit efc8b5a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions mkdocs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ To get started, you can run `make install`, which installs Poetry and all the de

If you want to install the library on the host, you can simply run `pip3 install -e .`. If you wish to use a virtual environment, you can run `poetry shell`. Poetry will open up a virtual environment with all the dependencies set.

> **Note:** If you want to use `poetry shell`, you need to install it using `pip install poetry-plugin-shell`. Alternatively, you can run commands directly with `poetry run`.
To set up IDEA with Poetry:

- Open up the Python project in IntelliJ
Expand Down

0 comments on commit efc8b5a

Please sign in to comment.