Added read me

README.md

@@ -1 +1,64 @@
-See https://designshift.ca/apps/atem-tally
+# Before You Start
+
+You should have a Raspberry Pi 3 or 4 with Raspbian OS that is already connected to the network either by ethernet or wifi. Also have your tally lights/LED connected to GPIO 17 (program) and GPIO 27 (preview).
+
+You will also need the ATEM Tally application installed from
+https://designshift.ca/apps/atem-tally
+
+# Installation
+
+1. Open the terminal on your Raspberry Pi
+
+2. Clone this project
+
+    ```
+    [email protected]:designshift/atem-tally-pi.git
+    ```
+
+3. Go into the directory and configure the application with the camera angle and the GPIOs that you would like to use with your Raspberry Pi
+
+    ```
+    cd atem-tally-pi
+    nano config.js
+    ```
+
+    Inside you'll see 3 values that you can edit. By default it uses GPIO 17 for program tally, GPIO 27 for preview tally, and it also listens as camera 1. Edit these values according to your hardware set up.
+
+    ```
+    const config = {
+	    "programGpio": 17,
+	    "previewGpio": 27,
+	    "camera": 1
+    }
+    ```
+
+    Refer to the Raspberry Pi documentation for [GPIO](https://www.raspberrypi.org/documentation/usage/gpio/) on the location and numbering of each pins.
+
+4. You can start the application by running. 
+
+    ```
+    node app.js
+    ```
+    Press Ctrl + C at any time to exit.
+
+5. Go over to the main ATEM Tally application and look for your Pi under the Pi menu. You may need to refresh the device list in the application to see it.
+
+    Once you've found your Raspberry Pi in the list, just select the check box to connect to it.
+
+6. Repeat from Step 3 as needed to adjust your configuration.
+
+# Running as a Service on Node
+
+Once you are happy with your configuration, we'll run this as a service on your Raspberry Pi so that it'll always be listening for connections when it is turned on.
+
+We'll skip over the explaination of what [pm2](https://pm2.keymetrics.io/) does and just give you the commands that you'll need to set up by default. Refer to the documentation for that if you need to change settings or remove the application.
+
+```
+sudo npm install -g pm2
+pm2 start app.js
+pm2 startup systemd
+sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup systemd -u pi --hp /home/pi
+pm2 save
+```
+
+That's it!