aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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