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

Updated readme

This commit is contained in:
Mark Qvist 2024-12-15 12:03:48 +01:00
parent e083fd2fb4
commit 78f2b5de3b
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -195,24 +195,36 @@ To install Sideband via `pip`, follow these instructions:
```bash ```bash
# Install Sideband and dependencies on macOS using pip: # Install Sideband and dependencies on macOS using pip:
pip3 install sbapp --user --break-system-packages pip3 install sbapp
# Optionally install RNS command line utilities: # Optionally install RNS command line utilities:
pip3 install rns pip3 install rns
# Run Sideband from the terminal: # Run Sideband from the terminal:
#################################
sideband
# or
python3 -m sbapp.main python3 -m sbapp.main
# Enable debug logging: # Enable debug logging:
#################################
sideband -v
# or
python3 -m sbapp.main -v python3 -m sbapp.main -v
# Start Sideband in daemon mode: # Start Sideband in daemon mode:
#################################
sideband -d
# or
python3 -m sbapp.main -d python3 -m sbapp.main -d
# If you add your pip install location to # If Python and pip was installed correctly,
# the PATH environment variable, you can # you can simply use the "sideband" command
# also run Sideband simply using: # directly. Otherwise, you will manually
sideband # need to add the pip binaries directory to
# your PATH environment variable, or start
# Sideband via the "python3 -m sbapp.main"
# syntax.
``` ```