From 14e331ad2ab7c5ffb546e0c14dd6164b517ff9ca Mon Sep 17 00:00:00 2001 From: localleon Date: Tue, 29 Oct 2019 17:46:51 +0100 Subject: [PATCH] Adding seperate Profile Sections in README --- INSTALL.md | 9 +-------- PROFILES.md | 16 ++++++++++++++++ README.md | 4 ++++ 3 files changed, 21 insertions(+), 8 deletions(-) create mode 100644 PROFILES.md diff --git a/INSTALL.md b/INSTALL.md index d3432fb..4589e43 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -65,11 +65,4 @@ Gentoo :
Same as install, but your profile and reboot files are preserved.
## Uninstall :
-`sudo make uninstall`
- -## Boot profiles :
-On boot, the keyboard is set with the udev file /etc/udev/rules.d/g810-led.rules
-This file launches the profile stored in /etc/g810-led/profile
-To prevent your keyboard flashing 3 times when you reboot use the systemd unit (g810-led-reboot).
- -Samples can be found in /etc/g810-led/samples.
+`sudo make uninstall`
\ No newline at end of file diff --git a/PROFILES.md b/PROFILES.md new file mode 100644 index 0000000..eaac74d --- /dev/null +++ b/PROFILES.md @@ -0,0 +1,16 @@ +# Profiles for your keyboard + +## Boot profiles :
+On boot, the keyboard is set with the udev file `/etc/udev/rules.d/g810-led.rules`
+This file launches the profile stored in `/etc/g810-led/profile`
+To prevent your keyboard flashing 3 times when you reboot use the systemd unit (g810-led-reboot).
+ +A profile looks like this: +``` +# G810-LED Profile (turn all keys on) + +a ffffff # Set all keys on + +c # Commit changes +``` +More samples can be found in [/etc/g810-led/samples.](https://github.com/MatMoul/g810-led/tree/master/sample_profiles)
diff --git a/README.md b/README.md index f178a92..960fe64 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ Linux led controller for Logitech G213, G410, G413, G512, G513, G610, G810, G910 ## Install :
* [INSTALL.md](https://github.com/MatMoul/g810-led/blob/master/INSTALL.md) +## Profiles :
+You can load predefined configurations on startup! +* [PROFILES.md](https://github.com/MatMoul/g810-led/blob/master/PROFILES.md) + ## Help :
`g213-led --help`
`g410-led --help`