Add README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..d8e9052
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+Code for an RGB lamp.
+
+Compiled with MPLAB X Beta 7.12.
+Uses PIC16LF1933 and a 4.2W RBGW LED module.
+
+Provides several functions:
+
+On/Off/Auto switch.  Auto is like on but automatically turns the lamp off
+after 5 hours, then back on again after 19 hours, repeating this process
+endlessly.
+
+Press and quickly release the button to cycle through the various operating
+modes.
+  - 1 mode for each color.  In these modes, the lamp is fixed on the
+    selected color.
+  - A color change mode.  Every 16 minutes, the lamp changes to the next
+    color in sequence, repeating the cycle endlessly.
+  - A 'party' mode, where colors are cycled rapidly.  The time spent in
+    each color and the time spent fading between colors is random.
+
+Press and hold the button to dim and brighten the lamp's output.