summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2015-05-28 08:04:42 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2015-05-28 11:57:34 +1000
commit767c1691cd520d873bea8175e22fa68a6027c29f (patch)
tree4ede11a1b6786d78311d54ea466545825fdc894b /README.txt
parente3673cc346b34825b191be92f3eea87491a9b066 (diff)
downloadlibinput-767c1691cd520d873bea8175e22fa68a6027c29f.tar.gz
README: spice up the readme a bit
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt43
1 files changed, 39 insertions, 4 deletions
diff --git a/README.txt b/README.txt
index c5dc61e5..3c7a5d54 100644
--- a/README.txt
+++ b/README.txt
@@ -9,22 +9,57 @@ applications that need to directly deal with input devices.
It provides device detection, device handling, input device event processing
and abstraction so minimize the amount of custom input code the user of
libinput need to provide the common set of functionality that users expect.
-
Input event processing includes scaling touch coordinates, generating
pointer events from touchpads, pointer acceleration, etc.
-libinput originates from weston, the Wayland reference compositor.
+libinput originates from
+[weston](http://cgit.freedesktop.org/wayland/weston/), the Wayland reference
+compositor.
+
+Source code
+-----------
The source code of libinput can be found at:
http://cgit.freedesktop.org/wayland/libinput
-For more information, visit:
+For a list of current and past releases visit:
http://www.freedesktop.org/wiki/Software/libinput/
+Reporting Bugs
+--------------
+
Bugs can be filed in the libinput component of Wayland:
https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland&component=libinput
-Online API documentation:
+Where possible, please provide an
+[evemu](http://www.freedesktop.org/wiki/Evemu/) recording of the input
+device and/or the event sequence in question.
+
+Documentation
+-------------
+
+Developer API documentation:
http://wayland.freedesktop.org/libinput/doc/latest/modules.html
+High-level documentation about libinput's features:
+http://wayland.freedesktop.org/libinput/doc/latest/pages.html
+
+License
+-------
+
+libinput is licensed under the MIT license.
+
+> Permission to use, copy, modify, distribute, and sell this software and its
+> documentation for any purpose is hereby granted without fee, provided that
+> the above copyright notice appear in all copies and that both that copyright
+> notice and this permission notice appear in supporting documentation, and
+> that the name of the copyright holders not be used in advertising or
+> publicity pertaining to distribution of the software without specific,
+> written prior permission. The copyright holders make no representations
+> about the suitability of this software for any purpose. It is provided "as
+> is" without express or implied warranty.
+
+See the [COPYING](http://cgit.freedesktop.org/wayland/libinput/tree/COPYING)
+file for the full license information.
+
*/