aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 6948942ba9c352b88ffcccb59eab9a860c98c504 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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.

Packages
--------
Regular releases are sporadic.  git master should be stable enough.  You can get
a package with the latest development version from Archlinux's AUR, or from
openSUSE Build Service for the rest of mainstream distributions.  Consult the
list of repositories and their respective links at:

https://build.opensuse.org/project/repositories/home:pjanouch:git

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://irc.janouch.name, channel #dev.

License
-------
'razer-bw-te-ctl' is written by Přemysl Janouch <p.janouch@gmail.com>.

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