From a5b166c525ab4f76b5f0582c95bf4c35d36ac670 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Sat, 19 Sep 2015 06:36:17 +1000 Subject: [PATCH] README: add basic instructions for adding new devices This is for the best case where it's just about adding a new device ID. In the case where reverse engineering is required, some more detailed instructions are necessary but they take more effort to write... Signed-off-by: Peter Hutterer --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 9875e700..7ed6a52e 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,17 @@ implemented. The HW driver then only accesses the bits required for libratbag. This allows us to optionally export the protocol as separate library in the future, if other projects require it. +Adding Devices +-------------- +Your device may already supported by one of our drivers. If so, you can +enable it by adding the device vendor-id/product-id to the static table. For +example, for a HID++ 1.0 device, edit the driver-hidpp10.c file and add an +entry in the hidpp10drv_table. For the other drivers, look for the +driver-{drivername}.c file and do the same. + +If the device doesn't work, you'll have to start reverse-engineering the +device-specific protocol. Good luck :) + License -------