Update Documentation

1 files changed, 48 insertions, 0 deletions

diff --git a/README.md b/README.md
index d7c9c69..5cb5c14 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,51 @@
 
 A template project to simplify development of web applications.
 
+
+## Expected Environment
+
+- GNU/Linux
+- systemd
+- Git, make and python3 are installed
+- Python modules flask, waitress and jinja2 are installed
+
+## Current State
+
+**Use it carefully!**
+
+It is already working, but the ```install``` and ```uninstall``` make targets have no checks. In the worst case you could overwrite or delete files on your machine in ```/opt``` or ```/etc/systemd/system```.
+
+## Usage
+
+The idea is that this repositry or any repository based on it is cloned on the production server and the development PC. Independent of the machine you can use it exactly the same. There is a ```debug``` target in the Makefile to test it and an ```install``` and ```uninstall``` target for the production server.
+
+Some examples:
+
+```
+# just try it
+git clone https://gitea.xengineering.eu/xengineering/web-template.git
+cd web-template
+make debug
+firefox http://127.0.0.1:8080/
+```
+
+```
+# install it on a production server
+git clone https://gitea.xengineering.eu/xengineering/web-template.git
+cd web-template
+nano ./src/config.ini  # tweak to your needs
+sudo make install
+sudo systemctl start <project_name>  # set the project name in config.ini
+```
+
+```
+# make your own project based on web-template
+git clone https://gitea.xengineering.eu/xengineering/web-template.git myproject
+cd myproject
+git remote rename origin template
+
+# get updates from web-template
+git fetch template
+git merge template/master
+```
+