From 4c239222cfb82fca1505b54036cec859a900b99b Mon Sep 17 00:00:00 2001 From: Tomasz Kramkowski Date: Sat, 3 Aug 2024 21:14:44 +0700 Subject: Mention how to build the program --- README.md | 3 +++ 1 file changed, 3 insertions(+) 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 -- cgit v1.2.3-54-g00ecf