Skip to content

Commit

Permalink
πŸ“ Update installation guide in README
Browse files Browse the repository at this point in the history
* Mention uv as first option for install
* Add note regarding installing in virtual environment
  • Loading branch information
RafaelWO committed Jan 2, 2025
1 parent aa1449a commit 8a46f00
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@


## Installation
It is recommended to install Pirel as a globally available CLI tool via `pipx` (or `uv tool`, etc.).
It is recommended to install Pirel as a globally available CLI tool via `uv` (or `pipx`, etc.).
This way you Pirel will show you the status of your active Python interpreter.

```
uv tool install pirel
```

OR

```
pipx install pirel
```
Expand All @@ -28,6 +34,9 @@ You can also install Pirel into a specific virtual environment.
pip install pirel
```

Not that in this case Pirel will only have access to the Python interpreter of this
very virtual environment.


## CLI Docs
**Usage**:
Expand Down

0 comments on commit 8a46f00

Please sign in to comment.