From 6590e9ed2da4b5d810ce746169e33f7cec6159d2 Mon Sep 17 00:00:00 2001 From: Daniel Pavel Date: Sat, 3 Nov 2012 16:18:02 +0200 Subject: [PATCH] readme updates --- INSTALL | 36 ------------------------------------ README | 20 +++++++++++++++++++- 2 files changed, 19 insertions(+), 37 deletions(-) delete mode 100644 INSTALL diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 091bcd44..00000000 --- a/INSTALL +++ /dev/null @@ -1,36 +0,0 @@ -Installation ------------- - - -1. Make the Logitech Unifying Receiver device available to standard users - -Normally USB devices are not accessible for r/w by regular users. - -In rules.d/ you'll find a udev rule file, to be copied in /etc/udev/rules.d/ (as -root). - -In its current form it makes the UR device available for r/w by all users -belonging to the 'plugdev' system group (standard Debian group for pluggable -devices). It may need changes, specific to your particular system's -configuration. - -If in doubt, replacing GROUP="plugdev" with GROUP="" should just -work. - - -2. Compile the hidapi native library. - -Solaar uses a thin ctypes layer on top of a native hidapi library to talk -directly to the UR device. Its source code is available here: -https://github.com/signal11/hidapi . - -The native library comes in two flavors, `hidraw` and `libusb`. You should -compile and use the hidraw implementation (in linux/); the libusb version -disconnects the device from the kernel and may cause your UR-connected devices -to stop working until you physically remove and re-insert the UR. - -Once compiled, you should copy the shared library (libhidapi-hidraw.so) to the -lib/native/ directory appropiate for your machine (most likely x86_64). - - -3. Start the application with ./bin/solaar diff --git a/README b/README index b408e9dc..e9c85343 100644 --- a/README +++ b/README @@ -19,8 +19,26 @@ Requirements - Python (2.7 or 3.2). - Gtk 3; Gtk 2 should partially work with some problems. - Python GI (GObject Introspection), for Gtk bindings. +- pyudev for enumerating udev devices. - Optional libnotify GI bindings, for desktop notifications. -- A hidapi native implementation (see the INSTALL file for details). + + +Installation +------------ + +Normally USB devices are not accessible for r/w by regular users, so you will +need to install a udev rule to allow access to the Logitech Unifying Receiver. + +In rules.d/ you'll find a udev rule file, to be copied in /etc/udev/rules.d/ (as +root). + +In its current form it makes the UR device available for r/w by all users +belonging to the 'plugdev' system group (standard Debian group for pluggable +devices). It may need changes, specific to your particular system's +configuration. + +If in doubt, replacing GROUP="plugdev" with GROUP="" should just +work. Thanks