aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 174da0e78c49cc5e135c5bb5bf07fdeef0521c67 (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
59
60
61
62
63
64
65
USB drivers
===========
:compact-option:

_usb-drivers_ is a collection of utilities to control various hardware over USB:

 - _eizoctl_ controls elementary settings of EIZO computer monitors.
+
It is intended as a replacement for official EIZO software,
and may not run at the same time, as it would contend for device access.

 - _eizoctltray_ is a derived Windows utility that can stay in the systray.

 - _elksmart-comm_ interfaces with ELK Smart infrared dongles,
   partially reimplementing the Ocrustar mobile app.
   While it does not build for Windows, this is incidental.

 - _razer-bw-te-ctl_ makes it possible to change the configuration of your Razer
   BlackWidow Tournament Edition keybooard.
+
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.

Packages
--------
Regular releases are sporadic.  git master should be stable enough.

You can get a package with the latest development version
as a https://git.janouch.name/p/nixexprs[Nix derivation].

Building
--------
Build dependencies:
 CMake, pkg-config, liberty (included), help2man +
Runtime dependencies:
 libusb-1.0 (elksmart-comm, razer-bw-te-ctl), hidapi >= 0.14 (eizoctl)

 $ git clone --recursive https://git.janouch.name/p/usb-drivers.git
 $ mkdir usb-drivers/build
 $ cd usb-drivers/build
 $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
 $ make

To install the applications, you can do either the usual:

 # make install

Or you can try telling CMake to make a package for you.  For Debian it is:

 $ cpack -G DEB
 # dpkg -i usb-drivers-*.deb

Contributing and Support
------------------------
Use https://git.janouch.name/p/usb-drivers to report bugs, request features,
or submit pull requests.  `git send-email` is tolerated.  If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License
-------
This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.