aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2013-06-09 00:29:57 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2013-06-09 00:58:34 +0200
commit452012093076c66cf5e934d47b43275bf0d0cf45 (patch)
treef7082a1f2e05e414a56d4518bb746b9394df3bac /README
parentf2ec1cf5b33d6218c702b9808f618f132d32ae6c (diff)
downloadsensei-raw-ctl-452012093076c66cf5e934d47b43275bf0d0cf45.tar.gz
sensei-raw-ctl-452012093076c66cf5e934d47b43275bf0d0cf45.tar.xz
sensei-raw-ctl-452012093076c66cf5e934d47b43275bf0d0cf45.zip
Update the README, fix CMake version requirement
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
index a449304..a8cd918 100644
--- a/README
+++ b/README
@@ -4,8 +4,19 @@ 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.
+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.
+
Installation
============
+Build dependencies: cmake >= 2.8.5, help2man, libusb >= 1.0,
+ gtk+ >= 3.0 (optional)
+
+$ git clone git://github.com/pjanouch/sensei-raw-ctl.git
+$ cd sensei-raw-ctl
$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
@@ -15,6 +26,8 @@ Note that there's no "make uninstall" and the GUI needs to be installed in the
right location to work correctly.
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.
For Debian-based distros, you can do the following instead of the last step:
$ cpack -G DEB