From d7d64d98716431a62deb2d1440df49f9d5d7de1f Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 1 Aug 2016 13:39:34 +1000 Subject: [PATCH] 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 (cherry picked from commit 14d0cd9d38520295fb9244869edfa4648dd9424b) --- README.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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 -------