commit 213d1cc99b0ff97329364c30a65d2cdd2d5b8dd9
Author: Mike Cifelli <1836280-mike-cifelli@users.noreply.gitlab.com>
Date:   Wed Dec 21 18:36:48 2022 -0500

    Initial commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b936b2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# chutney
+
+## Dependencies
+```
+sudo raspi-config nonint do_spi 0
+sudo apt install python3-pip python3-dev python3-spidev
+sudo pip3 install unicornhathd
+```
+
+## Configuration
+```
+TODO
+```
+
+## Installation
+```
+sudo ./install
+```
+
+## Output
+By default output will be in `/var/log/syslog`.
+A separate log file can be used by creating `/etc/rsyslog.d/30-chutney.conf` containing:
+```
+if $programname == 'chutney' then /var/log/chutney.log
+& stop
+```
+and then restart the rsyslog service:
+```
+sudo systemctl restart rsyslog
+```
+This log file can be rotated by creating `/etc/logrotate.d/chutney` containing:
+```
+/var/log/chutney.log
+{
+        rotate 14
+        daily
+        create
+        missingok
+        notifempty
+        compress
+        delaycompress
+        postrotate
+                /usr/lib/rsyslog/rsyslog-rotate
+        endscript
+}
+
+```