Browse Source

Added installation steps to readme

pull/1/head
Ravi Shah 5 years ago
parent
commit
10b76e882b
  1. 9
      README.md

9
README.md

@ -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 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. 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.
## 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/.
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`.
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 ## Screenshots
![Screenshot of main page](Screenshot%202020-12-26%20170542.png) ![Screenshot of main page](Screenshot%202020-12-26%20170542.png)
Loading…
Cancel
Save