Add a rudimentary README

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e2a489f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+xf86-input-libinput - a libinput-based X driver
+===============================================
+
+This is an X driver based on libinput. It is a thin wrapper around libinput,
+so while it does provide all features that libinput supports it does little
+beyond. It has no configuration options at the moment.
+
+***WARNING: misconfiguration of an X input driver may leave you without
+usable input devices in your X session. Use with caution.***
+
+
+Prerequisites
+-------------
+
+To build, you'll need the X.Org X server SDK (check your distribution for a
+xorg-x11-server-devel package or similar) and libinput (check your
+distribution for libinput-devel or similar).
+
+To get libinput from source, see:
+http://www.freedesktop.org/wiki/Software/libinput/
+
+To build the X server from source:
+http://www.x.org/wiki/Building_the_X_Window_System/
+
+Building
+--------
+
+To build this driver:
+
+    autoreconf -vif
+    ./configure --prefix=$HOME/build
+    make && make install
+
+Note that this assumes the same prefix as used in "Building the X Window
+System" above, adjust as required. If you want a system install, use a
+prefix of */usr*.
+
+Install the default configuration file:
+
+    cp conf/99-libinput.conf /etc/X11/xorg.conf.d/
+
+This will assign this driver to *all* devices. Use with caution.
+
+
+Bugs
+----
+
+Bugs in libinput go to the "libinput" component of wayland:
+https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland
+
+For Bugs in this driver, send me an email