summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2022-08-02 09:46:16 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2022-08-03 13:02:08 +1000
commit6064d7526a991c585e4aa809397eda44dc6c270e (patch)
tree4a2cebefdbf4e37f3901dbb626735d2cbaf16c22
parenta9653ab38df388d23e7fd98f512028c8e3dbe577 (diff)
downloadlibwacom-6064d7526a991c585e4aa809397eda44dc6c270e.tar.gz
README: minor fixes and a bit of rewording
The README is probably read more often than the wiki, so let's put the warning there too that libwacom doesn't make the tablet work. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index e9fcaa1..ba967cb 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,14 @@ 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 GUI toolkits (GNOME, KDE, others?) to map
-built-in tablets to the correct screen. SVG layout files are used to describe
-tablet construction.
+**libwacom does not make a tablet work.** libwacom is merely a database with a
+C library wrapper for *information* about a tablet. It has no effect on whether
+that tablet works.
+
+libwacom is currently used by GUI toolkits (GNOME, KDE, others?) to map
+built-in tablets to the correct screen and by libinput to determine configuration
+options such as the left-handed settings. SVG layout files are used to describe
+tablet visually.
# Adding tablet descriptions to libwacom
@@ -29,7 +34,7 @@ the tablet is not in that list.
`/usr/share/libwacom/cintiq-13hd.tablet`)
2. 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
+ database, no rebuild is necessary
3. The tablet is then available through `libwacom-list-local-devices`
You must update udev after installing the file, see below.