summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2016-08-01 13:39:34 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2016-08-05 08:58:28 +1000
commitd7d64d98716431a62deb2d1440df49f9d5d7de1f (patch)
treea473432c8da67998b2b477e01107a74e9f0d3e6d
parent33a6613671178db1cc0415c3c68085f1da42dc0e (diff)
doc: add links to the two debugging tools as examples
These are the simplest examples on how to use libinput and should be enough to get any potential user started. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> (cherry picked from commit 14d0cd9d38520295fb9244869edfa4648dd9424b)
-rw-r--r--README.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.txt b/README.txt
index f557f69c..b20ab3a9 100644
--- a/README.txt
+++ b/README.txt
@@ -67,6 +67,23 @@ 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
+Examples of how to use libinput are the debugging tools in the libinput
+repository. Developers are encouraged to look at those tools for a
+real-world (yet simple) example on how to use libinput.
+
+- A commandline debugging tool: https://cgit.freedesktop.org/wayland/libinput/tree/tools/event-debug.c
+- A GTK application that draws cursor/touch/tablet positions: https://cgit.freedesktop.org/wayland/libinput/tree/tools/event-gui.c
+
+libinput provides a
+[pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) file.
+Usually a program will use the `PKG_CHECK_MODULES` autoconf macro.
+Otherwise, the most rudimentary way to compile and link a program against
+libinput is:
+
+ gcc -o myprogram myprogram.c `pkg-config --cflags --libs libinput`
+
+For further information on using pkgconfig see the pkg-config documentation.
+
License
-------