From 96dd0f0915d1d9b037f34ffc5c592af054703760 Mon Sep 17 00:00:00 2001 From: Martchus Date: Fri, 8 Jul 2016 18:00:15 +0200 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cf8f538..817fac8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ -# Blackwidow control -Python script to enable macro keys of BlackWidow keyboard under GNU/Linux +# BlackWidow control +Python 3 script to enable macro keys of BlackWidow keyboard under GNU/Linux It just enables the macro keys which can then be configured as hotkeys in your desktop environment. However it does not enable the ability to record macros and to switch between different configurations like the Windows driver does. -This script has only been tested with the regular edition of the keyboard (the cheapest version which has no background light) using the firmware update from Razer Synapse 2.0. Hence the script might not work with other editions/firmware versions. +## Supported devices +The script is know to work with the following BlackWidow editions: +- regular edition (the ceapest one which has no background light) +- the regular 2013 edition + +### Notes +- The script likely works with the ultimate editions, too. However, this has not + been tested yet. +- The script does not work with the 2016 editions (yet). +- The script has been tested using the firmware update from Razer Synapse 2.0. + Hence the script might not work when an older firmware version is used. ## Instructions -Pyusb is required to run the script. -The repository PKGBUILDs (also on my GitHub page) contains files for building an Arch Linux package. +- Pyusb is required to run the script. +- Use ```-h``` for a list of available options. +- To invoke the script automatically when the keyboard is plugged-in an udev + rule can be added (see ```razer_blackwidow.rules```). +- The repository [PKGBUILDs](https://github.com/Martchus/PKGBUILDs) contains files + for building an Arch Linux package.