Skip to content

Commit

Permalink
docs: add note about Ubuntu 24.04 AppImage issues
Browse files Browse the repository at this point in the history
  • Loading branch information
isd-project committed Jan 27, 2025
1 parent 01ffd84 commit 9c1a95c
Showing 1 changed file with 43 additions and 36 deletions.
79 changes: 43 additions & 36 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,37 +37,28 @@ If you are interested, read on and take a look at the [recorded terminal session

`isd` can currently be installed in three different ways:

- As an [AppImage], via
- [nix], or via
- [uv].
- via [uv], or via
- [nix], or
- as an [AppImage].

=== "AppImage"

An [AppImage] is a single self-containing _executable_, similar to a Windows
`.exe` and MacOS `.dmg` file. This should make it easy to run `isd`
on _any_ Linux distribution and on remote servers where you do
not have elevated privileges.

_Manual installation_:
=== "uv"

First, download the `.AppImage` file from:
[uv] is a Python package manager.
To install [uv] have a look at the [official uv installation documentation](https://docs.astral.sh/uv/).

- <{{config['repo_url']}}/releases/latest>

Then make the file executable as
mentioned in the [AppImage documentation](https://docs.appimage.org/introduction/quickstart.html#ref-quickstart)
and run the application.
After installing [uv], you can _try_ `isd` by running:
`uvx --python=3.12 --from git+{{config['repo_url']}} isd`

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

Or manage the `.AppImage` via [AppImageLauncher](https://assassinate-you.net/tags/appimagelauncher/)
for better desktop integration support (application icon & entry) and in-app
update functionality.
`isd` requires `--python` to be set `>=3.12` and would fail
if the default Python version is older.
For more details regarding the tool management, see the upstream
[uv] tool documentation:

!!! warning
- <https://docs.astral.sh/uv/guides/tools/#installing-tools>

If you have `nix` installed, this `AppImage` will _not_ work!
Either use the `nix` or `uv` installation instructions!

=== "nix"

Expand Down Expand Up @@ -104,23 +95,39 @@ If you are interested, read on and take a look at the [recorded terminal session
```

=== "uv"
=== "AppImage"

[uv] is a Python package manager.
To install [uv] have a look at the [official uv installation documentation](https://docs.astral.sh/uv/).
An [AppImage] is a single self-containing _executable_, similar to a Windows
`.exe` and MacOS `.dmg` file. This should make it easy to run `isd`
on _any_ Linux distribution and on remote servers where you do
not have elevated privileges.

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

To install and manage `isd` via [uv], run:
`uv tool install --python=3.12 git+{{config['repo_url']}}`
First, download the `.AppImage` file from:

`isd` requires `--python` to be set `>=3.12` and would fail
if the default Python version is older.
For more details regarding the tool management, see the upstream
[uv] tool documentation:
- <{{config['repo_url']}}/releases/latest>

Then make the file executable as
mentioned in the [AppImage documentation](https://docs.appimage.org/introduction/quickstart.html#ref-quickstart)
and run the application.

_Managed installation_:

Or manage the `.AppImage` via [AppImageLauncher](https://assassinate-you.net/tags/appimagelauncher/)
for better desktop integration support (application icon & entry) and in-app
update functionality.

!!! warning

If you are using Ubuntu 24.04, extra installation steps are required.
Please see the [open issue #10](https://github.com/isd-project/isd/issues/10).

!!! warning

If you have `nix` installed, this `AppImage` will _not_ work!
Either use the `nix` or `uv` installation instructions!

- <https://docs.astral.sh/uv/guides/tools/#installing-tools>

## Working with `isd`

Expand Down

0 comments on commit 9c1a95c

Please sign in to comment.