From 3ea64ca7680d69259a0b07f2fe3d68acb783e169 Mon Sep 17 00:00:00 2001
From: Tanner Collin <git@tannercollin.com>
Date: Sun, 13 Nov 2022 19:48:09 -0700
Subject: [PATCH] Add setup instructions

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 8d0ee8d..73083df 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,64 @@
 
 This script plays a fake dog bark through speakers to scare people away from your house.
 
+
+## Setup
+
+Set up the Pi:
+
+```
+$ sudo usermod -aG audio tanner
+$ sudo apt update
+$ sudo apt install python3 python3-pip python3-virtualenv libsdl2-mixer-2.0-0 supervisor
+```
+
+Install woof:
+
+```
+$ git clone https://git.tannercollin.com/tanner/woof.git
+$ cd woof/
+$ virtualenv -p python3 env
+$ . env/bin/activate
+(env) $ pip install -r requirements.txt
+```
+
+Run manually to test it:
+```
+$ . env/bin/activate
+(env) $ python main.py
+```
+
+Ignore "(snd_pcm_recover) underrun occurred" errors.
+
+To start automatically, create `/etc/supervisor/conf.d/woof.conf`:
+
+```
+[program:woof]
+user=tanner
+directory=/home/tanner/woof
+command=/home/tanner/woof/env/bin/python -u main.py
+stopasgroup=true
+stopsignal=INT
+autostart=true
+autorestart=true
+stderr_logfile=/dev/null
+#stderr_logfile_maxbytes=10MB
+stdout_logfile=/var/log/woof.log
+stdout_logfile_maxbytes=10MB
+```
+
+Apply changes:
+
+```
+$ sudo supervisorctl reread; sudo supervisorctl reload
+$ sudo supervisorctl status
+$ tail -f /var/log/woof.log
+```
+
+
 ## License
 
 This program is free and open-source software licensed under the GNU Affero General Public License. Please see the `LICENSE` file for details.
 
 That means you have the right to study, change, and distribute the software and source code to anyone and for any purpose. You deserve these rights.
+