Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update README #75

Merged
merged 1 commit into from
Jan 23, 2025
Merged

doc: Update README #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
A container including every needed files, packages and dependencies to run the [Ankama launcher](https://www.ankama.com/en/launcher) and the related games (Dofus, Dofus-Retro, Wakfu).
It is meant to be used with [distrobox](https://github.com/89luca89/distrobox), the container won't be able to launch the Ankama launcher with plain old Docker / Podman *as is*.

Supports **SteamDeck/SteamOS** (given you installed `distrobox` and `podman` in a rootless way as described [here](https://github.com/89luca89/distrobox/blob/main/docs/posts/steamdeck_guide.md)).
Supports **SteamDeck / SteamOS** (given you installed `distrobox` and `podman` in a rootless way as described [here](https://github.com/89luca89/distrobox/blob/main/docs/posts/steamdeck_guide.md)).

*"Why would I use this instead of simply running the Ankama Launcher AppImage directly on my system?"*
Here are a few reasons why one would want to:
Expand Down Expand Up @@ -81,14 +81,14 @@ sudo make install-rootless

## Usage

Simply run the following command in order to run the container and launch the Ankama launcher:
Simply launch the `Ankama Launcher Container` application graphically via your application menu.

Alternatively, you can run the following command:

```bash
ankama-launcher-container
```

Alternatively, you can run the `Ankama Launcher Container` application graphically via your application menu like you would do with any other application.

## Update

### Upgrade the container
Expand Down Expand Up @@ -128,7 +128,7 @@ docker image prune -a || podman image prune -a

*Updating the host integration at each new release isn't generally necessary. If significant changes are made to the related files which would require an update, it will be noted in the release's notes.*

To update the host integration after a [new release](https://github.com/Antiz96/Ankama-Launcher-Container/releases) has been made, repeat the tasks listed in the [Installation/Host integration chapter](#install-the-host-integration).
To update the host integration after a [new release](https://github.com/Antiz96/Ankama-Launcher-Container/releases) has been made, repeat the tasks listed in the [Installation / Host integration chapter](#install-the-host-integration).

## Uninstallation

Expand Down