From 9f56d553235369f60c68c07f473d89492f04e27c Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 17 Sep 2020 13:45:23 +0200 Subject: Improve Documentation --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d7b66d3..027be25 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,25 @@ A small Web Application to shutdown or reboot your Raspberry Pi. -## Current State - -The code works but there is still documentation / automation missing. +## Usage +### Preparation -## Usage +Make sure to open your firewall on port 8080. **If** you use UFW you can do it like this: +```bash + sudo ufw allow 8080 +``` -**Please cd into the repository to install/uninstall!** +Install python3, Flask and waitress. python3 installation depends on your system. +With pip you can install Flask and waitress very easily: +```bash + sudo pip3 install Flask waitress +``` ### How to install, start and enable ```bash + git clone https://github.com/xengineering/picontrol.git + cd picontrol sudo useradd -rUs /usr/bin/nologin picontrol sudo make install sudo systemctl enable --now picontrol @@ -24,5 +32,6 @@ The code works but there is still documentation / automation missing. ### How to remove ```bash sudo systemctl disable --now picontrol - sudo make uninstall + sudo make uninstall # just works from picontrol directory (the git repository you cloned) + sudo userdel picontrol ``` -- cgit v1.2.3-70-g09d2