1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8ae88f0
--- /dev/null
+++ b/README
@@ -0,0 +1,8 @@
+This is coveraudiod, a simple daemon that plays typing sounds when using the
+Surface Pro 1/2 Touch Cover. These sounds are the same that are played under
+Windows.
+
+coveraudiod is designed to be run under a X11 session, and requires pulseaudio.
+
+To build, just do "make" and "sudo make install". The build requirements
+are Xlib (with XInput2), pulseaudio (with GLib support), GLib, and libsndfile.