summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index f2a0ff5..52fa61d 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,11 @@ g++ -std=c++17 -Wall -Wextra -I/usr/include/pipewire-0.3 -I/usr/include/spa-0.2
sudo mv beat_detector /usr/lib/caelestia/beat_detector
```
+> [!TIP]
+> The beat detector can actually be installed anywhere. However, if it is not installed to the default
+> location of `/usr/lib/caelestia/beat_detector`, you must set the environment variable `CAELESTIA_BD_PATH`
+> to wherever you have installed the beat detector.
+
## Usage
The shell can be started via the `caelestia shell -d` command or `qs -c caelestia`.