aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJavier <dev.git@javispedro.com>2014-08-15 21:01:17 +0200
committerJavier <dev.git@javispedro.com>2014-08-15 21:01:17 +0200
commit7c0a3a78e81fb60f46d3fab3f95337b370494e4e (patch)
tree2ebd5fe107c39d4bbcda4b06dc7d80c17d82ed3e /README
parent9694ec75ab1464b3699ef367f3800e60bef0cc7a (diff)
downloadcoveraudiod-7c0a3a78e81fb60f46d3fab3f95337b370494e4e.tar.gz
coveraudiod-7c0a3a78e81fb60f46d3fab3f95337b370494e4e.zip
adding readme, license
Diffstat (limited to 'README')
-rw-r--r--README8
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.