Add README

reinerh · Aug 13, 2017 · 74df93e · 74df93e
1 parent 7602083
commit 74df93e
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README b/README
@@ -0,0 +1,18 @@
+guitartools
+===========
+
+A collection of small tools that can be useful for guitar players.
+
+It currently includes:
+
+  * metronome: Beep in a specified pattern at a constant speed
+  * tuner: Measure tone frequencies and print nearest note
+
+The tools are using ALSA for playback and recording.
+
+Build dependencies:
+
+  * ALSA (e.g. libasound2-dev)
+  * FFTW 3.x (e.g. libfftw3-dev)
+
+Licensed under GPLv2 or any later version.