From 17c206422702d831c657bd01f973f007b8b35bfb Mon Sep 17 00:00:00 2001 From: MatMoul Date: Sun, 15 Jan 2017 02:09:26 +0100 Subject: [PATCH] Add INSTALL.md --- INSTALL.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 5 ++++- 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..88237ac --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,38 @@ +# Installation :
+ +## Build dependencies :
+* git +* g++ +* make + +## Dependencies :
+* libusb + +## Installation of dependencies :
+ArchLinux :
+`sudo pacman -S git gcc make libusb`
+Debian :
+`sudo apt-get install git g++ make libusb-1.0-0-dev`
+OpenSUSE :
+`zypper in git make gcc-c++ libstdc++-devel libusb-1_0-devel`
+CentOS :
+`sudo yum install git make gcc-c++ libstdc++-devel libusb-devel`
+ +## Installation :
+`git clone https://github.com/MatMoul/g810-led.git`
+`cd g810-led`
+`make`
+`sudo make install`
+ +## Update :
+Same as install, but your profile and reboot files are preserved.
+ +## Uninstall :
+`sudo make uninstall`
+ +## Boot profile :
+g810-led has 2 systemd units (g810-led and g810-led-reboot).
+These 2 units set the keyboard profile on boot and reboot.
+Profiles are stored in /etc/g810 :
+* /etc/g810/profile +* /etc/g810/reboot diff --git a/README.md b/README.md index 8fbd111..a3d1258 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ Linux LED controller for Logitech Led Keyboards.
- **G910 Orion Spectrum**
##Install and use :
-- look at the wiki : https://github.com/MatMoul/g810-led/wiki
+* INSTALL.md
+ +##Help :
+`g810-led --help`
##Samples :
`g810-led -p /etc/g810/profile # Load a profile`