From 815a81a6108c4f80d5a68b8ea3dc69c82ce4b0f7 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Thu, 10 Mar 2016 10:54:04 +1000 Subject: [PATCH] Spice up the README a bit Signed-off-by: Peter Hutterer --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 3fa02fdf..d7f1f751 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ ratbagd ratbagd is a system daemon to introspect and modify configurable mice. +ratbagd uses libratbag to access mice and exports the features over a DBus +API to unprivileged proceses. ratbagd needs permissions to access device +nodes (primarily /dev/hidraw nodes) and usually needs to run as root. + +ratbagd is a relatively thin wrapper arond libratbag. If a device is not +detected or does not function as expected, the issue is usually in +libratbag. libratbag can be found at + https://github.com/libratbag/libratbag + + Running ratbagd ---------------