Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Adrian D'Alessandro <[email protected]>
  • Loading branch information
HarmonicReflux and AdrianDAlessandro authored Nov 22, 2024
1 parent 78b5cf4 commit 1b46d84
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To get started:

1. Create and activate a [virtual environment](https://docs.python.org/3/library/venv.html).

**Note:** It is important that this environment is created with `Python 3.11`. It cannot be any higher or lower Python version due to `coldfront` limitations at the time of writing. You may note we ensure this requirenment in the `pyproject.toml` file by `requires-python = "~=3.11"`, but wish to mention it again explicitly here. A tool like `pyenv` that has any Python version activated tht is different from `Python 3.11`, can bypass this requirenment and lead to side effects.
**Note:** It is important that this environment is created with `Python 3.11`. It cannot be any higher or lower Python version due to `coldfront` limitations at the time of writing. You may note we ensure this requirement in the `pyproject.toml` file by `requires-python = "~=3.11"`, but wish to mention it again explicitly here.

Taking care of the note, we can then create a virtual environment from the command line like so:

Expand Down

0 comments on commit 1b46d84

Please sign in to comment.