aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorElias Fleckenstein <eliasfleckenstein@web.de>2022-07-28 21:46:07 +0200
committerElias Fleckenstein <eliasfleckenstein@web.de>2022-07-28 21:46:07 +0200
commitcc2668712870343af1901167799303a988a690a3 (patch)
tree998fff8939cf1c9721a843f0acfeba2740777770 /README.md
parentc1d9f6847d6c120c6d2996ad01e2ce3ece574209 (diff)
downloadline_audiolizer-cc2668712870343af1901167799303a988a690a3.tar.xz
Add options
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 89ea18a..767da30 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Line Audiolizer
Turn lines of code (or text files) into sound, written in Rust.
-Prints stdin, playing a tone for each line. The pitch of the tone depends on the length (or rather, UTF-8 width) of the line. Tabs count as 8 spaces.
+Prints stdin, playing a sine wave tone for each line. The pitch of the tone depends on the length (or rather, UTF-8 width) of the line.
Idea by [scplusplus](https://github.com/scplusplus).
@@ -16,3 +16,8 @@ Fancy print while playing, using [batcat](https://github.com/sharkdp/bat):
```sh
cargo run < src/main.rs | batcat --paging never --language rust
```
+
+For available options, see:
+```sh
+cargo run -- --help
+```