p/sensei-raw-ctl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Convert README to AsciiDoc

Browse Source
This commit is contained in:
Přemysl Eric Janouch 2015-09-27 01:32:57 +02:00
parent 6bfc9b0f1a
commit bdaa46a676
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README → README.adoc
View File

@ -1,11 +1,12 @@
sensei-raw-ctl sensei-raw-ctl
============== ==============
:compact-option:
This program makes it possible to change the configuration of your SteelSeries 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 Sensei Raw mouse from within Linux, *BSD or any other POSIX-compatible system
supported by libusb. supported by libusb.
Run `sensei-raw-ctl --help' or `man sensei-raw-ctl' for usage information. 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 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 available. On Ubuntu and its derivates, you should be able to find it in your
@ -19,29 +20,29 @@ Supported devices
Installation Installation
------------ ------------
Build dependencies: cmake >= 2.8.5, help2man Build dependencies: cmake >= 2.8.5, help2man +
Runtime dependencies: libusb >= 1.0, gtk+ >= 3.0 (optional) Runtime dependencies: libusb >= 1.0, gtk+ >= 3.0 (optional)
$ git clone git://github.com/pjanouch/sensei-raw-ctl.git $ git clone git://github.com/pjanouch/sensei-raw-ctl.git
$ cd sensei-raw-ctl $ mkdir sensei-raw-ctl/build
$ mkdir build $ cd sensei-raw-ctl/build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
# make install # make install
Note that there's no "make uninstall" and the GUI needs to be installed in the Note that there's no `make uninstall` and the GUI needs to be installed in the
right location in order to work correctly. right location in order to work correctly.
If you don't want the GUI frontend, append -DBUILD_GUI=NO to the cmake command. If you don't want the GUI frontend, append `-DBUILD_GUI=NO` to the cmake
The GUI also isn't going to be built if you don't have the GTK+ 3 development command. The GUI also isn't going to be built if you don't have the GTK+ 3
packages installed, if your distribution has any. development packages installed, if your distribution has any.
For Debian-based distros, you can do the following instead of the last step: For Debian-based distros, you can do the following instead of the last step:
$ cpack -G DEB $ cpack -G DEB
# dpkg -i sensei-raw-ctl-*.deb # dpkg -i sensei-raw-ctl-*.deb
Note that for versions of CMake before 2.8.9, you need to prefix cpack with Note that for versions of CMake before 2.8.9, you need to prefix cpack with
`fakeroot' or file ownership will end up wrong. `fakeroot` or file ownership will end up wrong.
Contributing and Support Contributing and Support
------------------------ ------------------------
@ -51,7 +52,7 @@ the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
License License
------- -------
`sensei-raw-ctl' is written by Přemysl Janouch <p.janouch@gmail.com>. 'sensei-raw-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 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 is included within the package, or, at your option, you may relicense the work