summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30c8b8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# ledctl
+
+A simple Python script to control a WS2812B LED or LED strip connected to a rasperry pi.
+systemd services are included to set the LED color depending on the current boot status.
+
+## Prerequisites
+
+Python 3
+The AdaFruit CircuitPython NeoPixel library
+
+## Configuration
+
+Blacklist the snd_bcm2835 module
+Edit /boot/config.txt and comment out dtparam=audio=on
+
+## Installation
+
+```
+sudo make install
+```
+