From 10b76e882b9d40274fcd7e7e5a4de069b74df186 Mon Sep 17 00:00:00 2001 From: rav4s Date: Thu, 22 Apr 2021 08:51:45 -0500 Subject: [PATCH] Added installation steps to readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1642b07..8597df5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # New-Pi-Garage-Door-Opener A rewrite of the Raspberry Pi Garage Door Opener using Flask. - + This repo contains a python script (garage_door_script.py), which runs a Flask web server that allows you to control and monitor your Raspberry Pi Garage Door Opener. This script assumes you have the same hardware configuration as described in this video: https://youtu.be/An7KQbmUnhs. - + ## Differences between this and the old python garage door control script (https://github.com/Rav4s/Pi-Garage-Door-Opener) Unlike the old script, this one allows you to view the status of your garage door and control it from one webpage. Also, once you sign in, it sets a cookie which allows you to stay signed in after closing and re-opening the page. Improvements have also been made for mobile usability and overall look and feel (see the screenshots below). @@ -11,11 +11,12 @@ The static folder contains the Bootstrap CSS framework, along with the main CSS The templates folder contains the index.html and login.html templates, which the python file uses to serve the webpages. The main python script is called garage_door_script.py. -## Dependencies -This python script requires python 3.x, Flask, and RPi.GPIO. +## Installation +The `install.sh` script makes installation of the dependencies and control script quick and easy. + +To get the installer script, enter your `/home/pi` directory and run `wget https://raw.githubusercontent.com/Rav4s/New-Pi-Garage-Door-Opener/main/install.sh`. After the file is downloaded, make it executable using `sudo chmod 755 install.sh`. Finally, run the script using `./install.sh`. -## How to run the script -To run the python script, first clone the repository using `git clone https://github.com/Rav4s/New-Pi-Garage-Door-Opener`. Then enter the directory using `cd New-Pi-Garage-Door-Opener`. Then finally run the script using `python3 garage_door_script.py`. Your web server will be accessible at http://serverip:1235/. +The script will install all dependencies, clone the repository, and create a systemd service that automatically runs the script on boot. After installation, your web server will be accessible at https://localhost:1235. ## Screenshots ![Screenshot of main page](Screenshot%202020-12-26%20170542.png)