Updated readme

This commit is contained in:
Mark Qvist 2024-06-29 18:03:21 +02:00
parent 9160dc19b8
commit c83798b123

View File

@ -39,8 +39,7 @@ After the application is installed on your Android device, it is also possible t
On all Linux-based operating systems, Sideband is available as a `pipx`/`pip` package. This installation method **includes desktop integration**, so that Sideband will show up in your applications menu and launchers. On all Linux-based operating systems, Sideband is available as a `pipx`/`pip` package. This installation method **includes desktop integration**, so that Sideband will show up in your applications menu and launchers.
#### Dependencies You will first need to install a few dependencies for audio messaging and Codec2 support to work:
Depending on your system, you will first need to install a few dependencies for audio messaging and Codec2 support to work:
```bash ```bash
# For Debian, Ubuntu and derivatives # For Debian, Ubuntu and derivatives
@ -54,8 +53,14 @@ sudo pacman -Sy python-pipx python-pyaudio base-devel codec2 xclip xsel
``` ```
#### Install application Once those are installed, install the Sideband application itself:
Once dependencies are installed, install the Sideband application itself:
```bash
# Finally, install Sideband using pipx:
pipx install sbapp
```
After installation, you can now run Sideband in a number of different ways:
```bash ```bash
# If this is the first time installing something with pipx, # If this is the first time installing something with pipx,
@ -64,9 +69,6 @@ Once dependencies are installed, install the Sideband application itself:
# to close and reopen your terminal after this. # to close and reopen your terminal after this.
pipx ensurepath pipx ensurepath
# Finally, install Sideband using pipx:
pipx install sbapp
# The first time you run Sideband, you will need to do it # The first time you run Sideband, you will need to do it
# from the terminal: # from the terminal:
sideband sideband