Add installation instructions to README

This commit is contained in:
ewen 2026-05-10 23:59:00 +02:00
parent bfa5549326
commit 90bbe737a2

View file

@ -25,6 +25,27 @@ The application reads connection settings from environment variables:
cargo build --release
```
The binary will be available at `target/release/qbit-tui`.
## Installing
To make `qbit-tui` available system wide, copy the built binary into a directory that is in your `PATH`:
```bash
# For the current user only (recommended)
mkdir -p ~/.local/bin
cp target/release/qbit-tui ~/.local/bin/
# Or for all users (requires sudo)
sudo cp target/release/qbit-tui /usr/local/bin/
```
Make sure `~/.local/bin` is in your `PATH`. If not, add this line to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
```bash
export PATH="$HOME/.local/bin:$PATH"
```
## Running
```bash