From 0f6978f1b8b7130b1c34f89904dfd1172c544699 Mon Sep 17 00:00:00 2001
From: litruv <litruv@gmail.com>
Date: Thu, 27 Aug 2026 04:47:43 +1000
Subject: [PATCH] Add setup-focused README.

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..505360a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# bass-manage
+
+Qt Quick / Kirigami control panel for the PipeWire **Bass Manage 7.1** virtual sink (`bass_manage.7.1`). Live tweaks for center→FL/FR fold, LFE mix, and LFE delay; **Save** writes `~/.config/pipewire/filter-chain.conf.d/50-bass-manage-lfe.conf`.
+
+## Requirements
+
+- Qt 6 (`qt6-base`, `qt6-declarative`, `qt6-wayland`, `qt6-svg`)
+- Kirigami 6 + `qqc2-desktop-style` (Plasma look)
+- PipeWire with `pw-cli` / `pw-dump`
+- Your bass-manage filter-chain already loaded (e.g. `filter-chain.service`)
+
+Arch/SteamOS packages (names may vary slightly):
+
+```bash
+sudo pacman -S --needed qt6-base qt6-declarative qt6-wayland qt6-svg \
+  kirigami qqc2-desktop-style cmake gcc
+```
+
+## Build & install
+
+```bash
+cd ~/dev/bass-manage   # or wherever you cloned this
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="$HOME/.local"
+cmake --build build -j"$(nproc)"
+cmake --install build
+```
+
+This installs:
+
+| Path | What |
+|------|------|
+| `~/.local/bin/bass-manage-gui` | App binary |
+| `~/.local/share/bass-manage/` | QML + Lucide icons |
+| `~/.local/share/applications/bass-manage-gui.desktop` | App menu entry |
+
+Ensure `~/.local/bin` is on your `PATH`.
+
+## Run
+
+```bash
+bass-manage-gui
+```
+
+Or open **Bass Manage 7.1** from the app launcher.
+
+Needs a Wayland (or X11) session and a running `bass_manage.7.1` sink:
+
+```bash
+systemctl --user status filter-chain.service
+pactl list short sinks | grep bass_manage
+```
+
+## PipeWire sink (if missing)
+
+The GUI does not create the virtual device. Put a filter-chain config in:
+
+`~/.config/pipewire/filter-chain.conf.d/50-bass-manage-lfe.conf`
+
+Then:
+
+```bash
+systemctl --user restart filter-chain.service
+pactl set-default-sink bass_manage.7.1
+```
+
+Point `playback.props.target.object` at your real 7.1 hardware sink.
+
+## Rebuild after changes
+
+```bash
+cmake --build ~/dev/bass-manage/build && cmake --install ~/dev/bass-manage/build
+```
+
+QML under the source tree is preferred when the binary was built with `BASS_MANAGE_SOURCE_DIR`, so UI edits in `qml/Main.qml` often apply on the next launch without reinstall.