From 9b4d29452bc16d25e8887d6969d3010e4146c037 Mon Sep 17 00:00:00 2001
From: Tanner <you@example.com>
Date: Tue, 14 Oct 2025 22:19:18 +0100
Subject: [PATCH] Begin README

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e696e70
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Protoflap
+
+Controls the welcome room Vestaboard directly, bypassing their cloud.
+
+
+
+
+## Setup
+
+
+### Supervisor
+
+Install supervisor:
+
+```
+# apt install supervisor
+# touch /etc/supervisor/conf.d/protoflap.conf
+# vim /etc/supervisor/conf.d/protoflap.conf
+```
+
+Set config to:
+
+```
+[program:protoflap]
+user=root
+directory=/root/protoflap
+command=/usr/bin/python /root/protoflap/protoflap.py
+stopsignal=INT
+stopasgroup=true
+killasgroup=true
+autostart=true
+autorestart=true
+stderr_logfile=/var/log/protoflap.log
+stderr_logfile_maxbytes=10MB
+stdout_logfile=/var/log/protoflap.log
+stdout_logfile_maxbytes=10MB
+```
+
+Load changes:
+
+```
+# supervisorctl reread; supervisorctl update
+```
+