Skip to content

Commit

Permalink
docs: update uv install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
isd-project committed Feb 1, 2025
1 parent bf32a57 commit 6ededfa
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,13 @@ If you are interested, read on and take a look at the [recorded terminal session
To install [uv] have a look at the [official uv installation documentation](https://docs.astral.sh/uv/).

After installing [uv], you can _try_ `isd` by running:
`uvx --python=3.12 --from git+{{config['repo_url']}} isd`
`uvx --python=3.12 isd-tui`

To install and manage `isd` via [uv], run:
`uv tool install --python=3.12 git+{{config['repo_url']}}`
`uv tool install --python=3.12 isd-tui`

After installing the tool, the program `isd` and its alias[^alias] `isd-tui`
will be available.

`isd` requires `--python` to be set `>=3.12` and would fail
if the default Python version is older.
Expand Down Expand Up @@ -308,3 +311,7 @@ Checkout the other sections as well:
- [FAQ](./faq.md)
- [Security](./security.md)

[^alias]: The reason why the `isd-tui` alias exists is due to a naming conflict
on PyPI with a different package called `isd`. Providing the alias `isd-tui`
allows `uv` users to try it without having to write `uvx --from isd-tui isd`.

0 comments on commit 6ededfa

Please sign in to comment.