From 9c6f59035d63b68149946716525fdbb535d4adfc Mon Sep 17 00:00:00 2001 From: Peder Bergebakken Sundt Date: Mon, 26 Feb 2018 23:15:08 +0100 Subject: [PATCH] Add a "How to run this" section to readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index c93a901..9ac5cab 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ A simple webui to interface with the [Grzegorz API](https://github.com/Programvareverkstedet/grzegorz) +## How to run this + +First of we need to install any needed dependencies. If you want to, you may do so in a virtual environment. + +To install the needed dependencies, run this with sufficient rights (as root?): + +``` +pip install -r requirements.txt +``` + +Now, make a copy of `default_config.py` named `config.py`, and make any changes you see fit. Here is a description of each field: + +* `host` - The interace you want to listen to +* `port` - The port to listen to +* `start_browser` - Whether to open a window in the defualt browser of the interface when starting +* `multiple_instance` - Whether to handle each client induvidually or with a single instance + +When finished, start the server with: + +``` +python3 main.py +``` + ## License Licensed under BSD 3 clause, see the file LICENSE for more details