diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2014-12-09 13:19:54 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2014-12-11 12:26:03 +1000 |
| commit | 5ad756ea39da3542c2f05b5111b1f760d01a6385 (patch) | |
| tree | 1d86c0fd8fbd29aa5bd9dd7c798247ea90f3f10c /README.txt | |
| parent | dd624f50389d8ff63df8297bac9c1d3984d43fb4 (diff) | |
doc: include README as mainpage
doxygen supports markdown so we can expand the README with general interesting
information in markdown format and have it be the front page of the
documentation at the same time.
This requires renaming README to README.txt, but that's a relatively small
price to pay.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..fabe304 --- /dev/null +++ b/README.txt @@ -0,0 +1,30 @@ +/*!@mainpage + +libinput +======== + +libinput is a library that handles input devices for display servers and other +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. + +The source code of libinput can be found at: +http://cgit.freedesktop.org/wayland/libinput + +For more information, visit: +http://www.freedesktop.org/wiki/Software/libinput/ + +Bugs can be filed in the libinput component of Wayland: +https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland + +Online API documentation: +http://wayland.freedesktop.org/libinput/doc/latest/modules.html + +*/ |