Add a "How to run this" section to readme
This commit is contained in:
parent
e63b076e60
commit
9c6f59035d
23
README.md
23
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
|
||||
|
|
Loading…
Reference in New Issue