From cdd70105b59296519e885768627997d86d667afd Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 17 Jun 2019 09:44:41 +1000 Subject: [PATCH] data: add a README for devices, remove the svg one We don't ship SVGs here anymore, so let's remove that README. And instead add one to the devices directory. Signed-off-by: Peter Hutterer --- data/README.md | 17 ----------------- data/devices/README.md | 11 +++++++++++ 2 files changed, 11 insertions(+), 17 deletions(-) delete mode 100644 data/README.md create mode 100644 data/devices/README.md diff --git a/data/README.md b/data/README.md deleted file mode 100644 index a8ddfde9..00000000 --- a/data/README.md +++ /dev/null @@ -1,17 +0,0 @@ -libratbag data files -==================== - -This directory contains the SVG files for each theme. In general, device SVGs -should approximate the device to make it immediately recognizable. Detail work -not required, the graphic is an illustration only. - -For theme-specific requirements, consult the README in the subdirectories. - -Technique ---------- - -The simplest approach is to find a photo of the device and import it into -inkscape. Put it on the lowest layer, create a new layer "Device" above it -and start tracing the outlines and edges of the device. Fill in the shapes -and your device should resemble the underlying photo. Delete the photo -layer, add leaders and button labels and you're done. diff --git a/data/devices/README.md b/data/devices/README.md new file mode 100644 index 00000000..25223599 --- /dev/null +++ b/data/devices/README.md @@ -0,0 +1,11 @@ +libratbag data files +==================== + +This directory contains the data files for each supported device. libratbag +reads these files to identify the backend driver for any given device. If a +device is not listed, libratbag will not support it. + +See the device.example file for instructions on the various options. + +See the libratbag wiki for more information: +https://github.com/libratbag/libratbag/wiki/Adding-a-device/