From 7696d0fa923b54856c2cdc8da6e2daffab174089 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 27 Sep 2015 01:48:07 +0200 Subject: Convert README to AsciiDoc --- README.adoc | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.adoc (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..ee18b70 --- /dev/null +++ b/README.adoc @@ -0,0 +1,49 @@ +razer-bw-te-ctl +=============== + +This program makes it possible to change the configuration of your Razer +BlackWidow Tournament Edition keybooard from within Linux, *BSD or any other +POSIX-compatible system supported by libusb. + +Make sure to let the Windows Razer Synapse tool upgrade the firmware to the +newest version before running the program. There might be some issues otherwise +due to protocol changes, although I don't really deem it very probable. + +Run `razer-bw-te-ctl --help` or `man razer-bw-te-ctl` for usage information. + +Installation +------------ +Build dependencies: cmake >= 2.8.5, help2man + +Runtime dependencies: libusb >= 1.0 + + $ git clone git://github.com/pjanouch/razer-bw-te-ctl.git + $ mkdir razer-bw-te-ctl/build + $ cd razer-bw-te-ctl/build + $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr + # make install + +Note that there's no `make uninstall`. + +For Debian-based distros, you can do the following instead of the last step: + + $ cpack -G DEB + # dpkg -i razer-bw-te-ctl-*.deb + +Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with +`fakeroot` or file ownership will end up wrong. + +Contributing and Support +------------------------ +Use this project's GitHub to report any bugs, request features, or submit pull +requests. If you want to discuss this project, or maybe just hang out with +the developer, feel free to join me at irc://anathema.irc.so, channel #anathema. + +License +------- +'razer-bw-te-ctl' is written by Přemysl Janouch . + +You may use the software under the terms of the ISC license, the text of which +is included within the package, or, at your option, you may relicense the work +under the MIT or the Modified BSD License, as listed at the following site: + +http://www.gnu.org/licenses/license-list.html -- cgit v1.2.3