sensei-raw-ctl/README.adoc

62 lines
2.1 KiB
Plaintext
Raw Normal View History

2013-05-26 10:54:42 +02:00
sensei-raw-ctl
2015-02-26 22:59:06 +01:00
==============
2015-09-27 01:32:57 +02:00
:compact-option:
2013-05-26 10:54:42 +02:00
This program makes it possible to change the configuration of your SteelSeries
Sensei Raw mouse from within Linux, *BSD or any other POSIX-compatible system
supported by libusb.
2015-09-27 01:32:57 +02:00
Run `sensei-raw-ctl --help` or `man sensei-raw-ctl` for usage information.
If you don't fancy command line tools, there's also a basic GTK+ frontend
available. On Ubuntu and its derivates, you should be able to find it in your
System Settings.
Supported devices
2015-02-26 22:59:06 +01:00
-----------------
- SteelSeries Sensei Raw
- SteelSeries Call of Duty: Black Ops II
- SteelSeries Guild Wars 2
2013-05-26 10:54:42 +02:00
Installation
2015-02-26 22:59:06 +01:00
------------
2015-09-27 01:32:57 +02:00
Build dependencies: cmake >= 2.8.5, help2man +
2015-02-26 22:59:06 +01:00
Runtime dependencies: libusb >= 1.0, gtk+ >= 3.0 (optional)
2015-02-26 22:59:06 +01:00
$ git clone git://github.com/pjanouch/sensei-raw-ctl.git
2015-09-27 01:32:57 +02:00
$ mkdir sensei-raw-ctl/build
$ cd sensei-raw-ctl/build
2015-02-26 22:59:06 +01:00
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
# make install
2013-05-26 10:54:42 +02:00
2015-09-27 01:32:57 +02:00
Note that there's no `make uninstall` and the GUI needs to be installed in the
right location in order to work correctly.
2013-06-09 00:15:04 +02:00
2015-09-27 01:32:57 +02:00
If you don't want the GUI frontend, append `-DBUILD_GUI=NO` to the cmake
command. The GUI also isn't going to be built if you don't have the GTK+ 3
development packages installed, if your distribution has any.
2013-06-09 00:15:04 +02:00
For Debian-based distros, you can do the following instead of the last step:
2015-09-27 01:32:57 +02:00
2015-04-16 20:05:23 +02:00
$ cpack -G DEB
2015-02-26 22:59:06 +01:00
# dpkg -i sensei-raw-ctl-*.deb
2013-06-27 22:12:02 +02:00
2015-02-26 22:59:06 +01:00
Note that for versions of CMake before 2.8.9, you need to prefix cpack with
2015-09-27 01:32:57 +02:00
`fakeroot` or file ownership will end up wrong.
2015-02-26 22:59:06 +01:00
2015-09-27 01:30:19 +02:00
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.
2015-02-26 22:59:06 +01:00
License
-------
2015-09-27 01:32:57 +02:00
'sensei-raw-ctl' is written by Přemysl Janouch <p.janouch@gmail.com>.
2015-02-26 22:59:06 +01:00
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