Skip to content

Commit

Permalink
readme: explain venv, then pip
Browse files Browse the repository at this point in the history
  • Loading branch information
raehik committed Sep 22, 2023
1 parent 5fac2ac commit 9e42681
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,9 @@ For more details on each of the stages, see the [`docs`](docs/) directory.

## Usage
### Dependencies
Python 3 is required.
Python 3.9 or newer is required. We primarily test on Python 3.11.

#### Python
With `pip` installed, run the following in the root directory:

pip install -e .

To avoid any conflicts with local packages, we recommend using a virtual
environment. In the root directory:

Expand All @@ -47,7 +43,13 @@ environment. In the root directory:

See [virtualenv docs](https://virtualenv.pypa.io/en/latest/) for more details.

Alternatively, if you are using python to manage virtual environments using the `venv` module, then the first line above can be replaced by `python -m venv venv` (where the second `venv` is the virtual environment name).
Alternatively, if you are using python to manage virtual environments using the
`venv` module, then the first line above can be replaced by `python -m venv
venv` (where the second `venv` is the virtual environment name).

With `pip` installed, run the following in the root directory:

pip install -e .

*(An alternate `pyproject.toml` file is provided for building with
[Poetry](https://python-poetry.org/). To use, rename `pyproject-poetry.toml` to
Expand Down

0 comments on commit 9e42681

Please sign in to comment.