From cc04f3d2baeba01a5c2bf56138f9b910f3e0384d Mon Sep 17 00:00:00 2001
From: paukstelis <paukstel@umd.edu>
Date: Wed, 18 May 2022 12:30:44 -0400
Subject: [PATCH] update README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4c21138
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+Updated May 2022.  
+Want to support this work? Buy Me a Coffee. https://www.buymeacoffee.com/ppaukstelis.
+Need help with octoprint_deploy? You can open issues here or ask on Discord: https://discord.gg/6vgSjgvR6u
+# octoprint_deploy
+These files provide a simple bash script for quickly deploying multiple octoprint instances on a single computer.
+# BIG CHANGES
+As of 02/22 there is no longer a need to download a specific image file.
+YouTube video for OctoPi setup here: https://www.youtube.com/watch?v=J5VzI4AFav4&lc
+# How to use
+* OctoPi
+  * Put the latest OctoPi image on your SD card
+  * ssh into your Pi (pi@octopi.local; good idea to change your password now!)
+  * run the command `git clone https://github.com/paukstelis/octoprint_deploy.git`
+  * run the command `sudo octoprint_deploy/octoprint_deploy.sh`
+  * Choose `Prepare System` from the menu
+  * Setup admin user by connecting to http://octopi.local via browser
+  * Back in the ssh session, choose `Add Instance` and follow the instructions.
+  * If your printer does not have a serial number, it will time out and use the physical USB address for udev entries.
+  * Continue until you have added all the printers you want to use
+  * haproxy entries are updated so you can connect via http://octopi.local/instancename/ (trailing slash is needed)
+* Ubuntu/Mint/Fedora (Fedora not completely tested)
+  * __You do not need to install OctoPrint using any Wiki instructions. The script will do it for you__
+  * Install Ubuntu 18-22.X, Mint 20.3+, Debian, or Fedora35+ on your system (make sure your user is admin for sudo)
+  * Install git if it isn't already: `sudo apt install git` or `sudo dnf install git`
+  * run the command `git clone https://github.com/paukstelis/octoprint_deploy.git`
+  * run the command `sudo octoprint_deploy/octoprint_deploy.sh`
+  * Choose `Prepare System` from the menu. Select your distribution type. This will install necessary packages, install OctoPrint, and start a template instance
+  * You will be asked which streamer you would like to install (mjpg-streamer or ustreamer).
+  * This converts your installation into an 'OctoBuntu'-style installation. Use `OctoBuntu` for all identifiers after this point.
+  * Setup admin user by connecting to your system (either http://localhost:5000 or http://[hostname]:5000 via browser
+  * Continue with octoprint_deploy script and setup all your instances.
+* What else can you do?
+  * Remove instances
+  * Add USB webcams AFTER you've created the instance
+  * Test USB connections
+  * Want to get rid of everything? `sudo octoprint_deploy/octoprint_deploy.sh remove`
+# Recent Changes
+* Add duplicate serial number detection.
+* Add architecture check to minimize errors where a system gets prepared as OctoPi when someone is using Ubuntu/Fedora/etc.
+* Include ustreamer as an option for camera streaming
+* Add remove command-line argument to get rid of all the stuff the script has done.
+