From c1d9f6847d6c120c6d2996ad01e2ce3ece574209 Mon Sep 17 00:00:00 2001
From: Elias Fleckenstein
 <54945686+EliasFleckenstein03@users.noreply.github.com>
Date: Thu, 28 Jul 2022 21:00:38 +0200
Subject: Create README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89ea18a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# 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.
+
+Idea by [scplusplus](https://github.com/scplusplus).
+
+## Example
+
+Play own source code:
+```sh
+cargo run < src/main.rs
+```
+
+Fancy print while playing, using [batcat](https://github.com/sharkdp/bat):
+```sh
+cargo run < src/main.rs | batcat --paging never --language rust
+```
-- 
cgit v1.2.3