From 220725d98911b98b80def4f489f467dbad5d300a Mon Sep 17 00:00:00 2001 From: Marek Isalski Date: Sat, 16 Jun 2018 16:26:53 +0200 Subject: [PATCH 1/2] add a bit more detail to the README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 2518000..2e7140b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +## Installation + +We are using [Pipenv](https://docs.pipenv.org) to make our lives easier: + +```sh +git clone https://gitea.faelix.net/FAELIX/incident_handler.git +cd incident_handler +pipenv install --three +``` + +## Configuration + Example `settings.cfg` file: ```python @@ -22,3 +34,11 @@ PUBLIC_INCIDENT_PREFIX = "FI#" STATUS_PAGE_URL = "https://status.faelix.net/" INCIDENT_URL_SCHEME = STATUS_PAGE_URL + "event/%s/" ``` + +## Running + +```sh +export FIH_SETTINGS=~/incident_handler/settings.cfg +export FLASK_APP=fih.py +cd ~/incident_handler +flask run -p 3333 From 9a5601bc2a3ede318560cc15e3123ad38c062c02 Mon Sep 17 00:00:00 2001 From: Marek Isalski Date: Sat, 16 Jun 2018 16:27:19 +0200 Subject: [PATCH 2/2] add a bit more detail to the README.md (fix mistaek) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2e7140b..e932855 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,4 @@ export FIH_SETTINGS=~/incident_handler/settings.cfg export FLASK_APP=fih.py cd ~/incident_handler flask run -p 3333 +```