A missing tablet description is the most common situation that users of tablets face, let's add it to the README. And since that also affects people with installed version of libwacom, add guidelines for a local install too.
Signed-off-by: Peter Hutterer <peter.hutte...@who-t.net> --- README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README b/README index 525412e..1b0a724 100644 --- a/README +++ b/README @@ -2,6 +2,9 @@ libwacom is a library to identify wacom tablets and their model-specific features. It provides easy access to information such as "is this a built-in on-screen tablet", "what is the size of this model", etc. +This functionality is currently used by e.g. GNOME to map built-in tablets +to the correct screen. + == Debugging libwacom with uinput devices == libwacom by default will not recognise uinput devices. To debug and test, a physical device must be connected. @@ -18,3 +21,28 @@ Some limitations: DO NOT USE THESE UINPUT RULES unless you are debugging with uinput devices. Remove the rules once debugging is done. + +== Adding tablet descriptions to libwacom == +A common indicator that a device is not supported by libwacom is that it +works normally in a GNOME session, but the device is not correctly mapped to +the screen. + +Use the libwacom-list-local-devices tool to list all local devices +recognized by libwacom. If your device is not listed, but it is available +as an event device in the kernel (see /proc/bus/input/devices) and in the X +session (see xinput list), the device is missing from libwacom's database. + +To add support for a new tablet to libwacom create a new tablet definition +file. See data/wacom.example in the source for a guideline on how +to add a new tablet. For an installed version of libwacom, see the existing +data files (e.g. /usr/share/libwacom/cintiq-13hd.tablet). +A new tablet description is enabled by adding and installing a new file +with a .tablet suffix. Once installed the tablet is part of libwacom's +database, no rebuild is neccessary. The tablet is then available +through libwacom-list-local-devices. + +The device should also be added to the udev rule to ensure all required +properties are set. When building from source generate an update ruleset +with tools/generate-udev-rules after adding the tablet descripton to. When +updating an installed version of libwacom, add it manually to the existing +ruleset (/lib/udev/rules.d/65-libwacom.rules). -- 2.1.0 ------------------------------------------------------------------------------ _______________________________________________ Linuxwacom-devel mailing list Linuxwacom-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linuxwacom-devel
