]> git.lizzy.rs Git - line_audiolizer.git/blobdiff - README.md
Add options
[line_audiolizer.git] / README.md
index 89ea18a37d0b2096789b2bbe295e37c55ca13eb9..767da303ca9bb0aa84aa134d4a512362191031c6 100644 (file)
--- 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
+```