jacob.eva/openCom-Companion
1
0
Fork 0
mirror of https://github.com/liberatedsystems/openCom-Companion.git synced 2024-11-22 13:30:36 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md, closes #50

Browse Source
This commit is contained in:
markqvist 2024-06-07 18:31:40 +02:00 committed by GitHub
parent fc10cededd
commit f64a8905e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -42,7 +42,7 @@ On all Linux-based operating systems, Sideband is available as a `pip` package.
# a command like one of the following: # a command like one of the following:
pamac install python-pyaudio # Manjaro pamac install python-pyaudio # Manjaro
sudo pacman -Sy python-pyaudio # Arch sudo pacman -Sy python-pyaudio # Arch
sudo apt install python3-pyaudio # Debian and derivatives sudo apt install python3-pyaudio # Debian and derivatives
# Install the Sideband application: # Install the Sideband application:
@ -120,7 +120,11 @@ When running Sideband for the first time, a default Reticulum configuration file
## Installation With pipx ## Installation With pipx
You *can* use the `pipx` tool to install Sideband in an isolated environment, but on Linux you will have to launch Sideband from the command line, or create your own launcher links, since `pipx` does not support desktop integration. Unfortunately, it does not seem like `pipx` will be adding desktop integration in the near future, so restoring the original `pip` tool to its proper behaviour is recommended for now. If you want to use `pipx` anyway, it is as simple as: While I wouldn't generally recommend it, you *can* use the `pipx` tool to install Sideband, but on Linux you will have to launch Sideband from the command line, or create your own launcher links, since `pipx` does not support desktop integration. Unfortunately, it does not seem like `pipx` will be adding desktop integration in the near future, so restoring the original `pip` tool to its proper behaviour is recommended for now.
The `pipx` installer also has trouble with including distribution-installed Python packages, so you will need to install additional packages on your system that will allow `pipx` to build required dependencies from source. In general, it will require a working build environment and header files for PortAudio. On Debian and derivatives, this would look something like `sudo apt install build-essential portaudio19-dev`. On Manjaro you would want something like `pamac install base-devel portaudio`.
If you want to use `pipx` anyway, and after the necessary dependencies are installed, you can simply do:
```bash ```bash
# Install Sideband on Linux: # Install Sideband on Linux: