aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomasz Kramkowski <tomasz@kramkow.ski>2024-08-03 21:14:44 +0700
committerTomasz Kramkowski <tomasz@kramkow.ski>2024-08-03 21:14:44 +0700
commit4c239222cfb82fca1505b54036cec859a900b99b (patch)
treea6f8d1a8b5d690611691047b616bf06c7ec8682b
parent9137fa060627aecc34aa59dbb21b2021a641144c (diff)
downloadbeeps-4c239222cfb82fca1505b54036cec859a900b99b.tar.gz
beeps-4c239222cfb82fca1505b54036cec859a900b99b.tar.xz
beeps-4c239222cfb82fca1505b54036cec859a900b99b.zip
Mention how to build the program
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index b74393c..200ed2a 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,9 @@ The final wind-down beeps let you know when you should stop.
## Usage
+Use `cargo build` or `cargo build --release` to build the program. Optionally it
+can be installed system-wide using `cargo install --path .`.
+
Run `beeps 300` for a roughly 5 minute track (additional time required for
initial beep and wind-down beeps). The program will output an 8 bit unsigned
8kHz PCM track. This can be piped directly into a program like `aplay` or