summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpommicket <leonardomtenenbaum@gmail.com>2016-01-24 19:24:50 -0500
committerpommicket <leonardomtenenbaum@gmail.com>2016-01-24 19:24:50 -0500
commit6af14760694a83b91e4c4ae685b6731f11fc2abe (patch)
treeea0fcc8fdb5d77dbd526db706540d886a1a0063d /README.md
parentc2f2a26bd7c3e3dc53dedb0245f3b7839991b260 (diff)
Edited readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index dacd89b..3a4293c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
# BeePi
Uses the system speaker to play pi
+
+**GNU/Linux only**
+
+**Requires [beep](http://www.johnath.com/beep/)**
+
+Takes the digits of pi and plays them using the following notes for each digit:
+0 - B3
+1 - C4
+2 - D4
+3 - E4
+4 - F4
+5 - G4
+6 - A4
+7 - B4
+8 - C5
+9 - D5
+
+Pi is stored in pi.txt
+
+To run BeePi:
+```
+./beepi [msPerNote]
+```
+Where msPerNote is the number of milliseconds per beep. (defaults to 200)
+
+To build the source:
+```
+make
+```