aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9f046f7..6e79607 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,22 @@
# Intel NUC LED Controller
-GUI and command line tool to control the front panel LED ring on Intel NUCs.
+Simple GUI tool to control the front panel LED ring on Intel NUCs.
Requires the 'SW Control' option to be set in the BIOS.
-This application request to run as admin in order to use the WMI interface to control the LED.
+![manual control](http://james-barnett.net/files/intel-nuc-led-controller/screenshots/manual.png) ![auto control](http://james-barnett.net/files/intel-nuc-led-controller/screenshots/auto.png)
+
+## Install
+Grab the latest release zip [here](https://github.com/jamesbarnett91/intel-nuc-led-controller/releases/download/v0.2/NucLedController-v0.2.zip) (or from the releases page).
+Unzip somewhere, and run NucLedController.exe
+
+
+## Use
+This tool provides options for both manual control and some experimental automatic controls.
+In manual mode the desired LED colour and blink/fade rates can be set, or the LED disabled all together.
+
+Currently the automatic control options allow cycling or fading between all the LED colours at a given rate. Lower rates (i.e. quicker colour changes) will consume more CPU resources to manage.
+These automatic modes are fully controlled by this software, and so the program must be left running to use these modes.
+In manual mode the setting can be applied and the application closed.
+
+
+Note that this application requests to run as admin in order to use the WMI interface to control the LED.
I'm not a C# developer so some of this may be janky. \ No newline at end of file