Mirrors
/
Sideband
mirror of https://github.com/markqvist/Sideband.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

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

30
README.md
View File

@ -48,18 +48,6 @@ sudo apt install python3-pyaudio # Debian and derivatives
# Install the Sideband application:
pip install sbapp
# Find the Sideband application in your launcher,
# or run it directly from the command line:
sideband
# You can also run Sideband with more verbose
# log output enabled:
sideband -v
# You can also run Sideband in headless daemon
# mode, for example as a telemetry collector:
sideband --daemon
# If you intend to run Sideband in headless
# daemon mode, you can also install it without
# any of the normal UI dependencies:
@ -80,6 +68,24 @@ break-system-packages = true
You can also simply add the `--break-system-packages` directive on a per-installation basis. For example, on a system that blocks normal user package installation, you can install Sideband by running `pip install sbapp --break-system-packages`.
After installation is complete, you can either run Sideband from your launcher or applications menu, or from the command line:
```bash
# Find the Sideband application in your launcher,
# or run it directly from the command line:
sideband
# You can also run Sideband with more verbose
# log output enabled:
sideband -v
# You can also run Sideband in headless daemon
# mode, for example as a telemetry collector:
sideband --daemon
```
## Installation On macOS
A DMG file containing a macOS app bundle is available on the [latest release](https://github.com/markqvist/Sideband/releases/latest) page.