Updated 'Readme.md'

This commit is contained in:
Ben D
2022-03-15 11:52:58 -07:00
parent 67baa2986f
commit fcb0828432

View File

@@ -22,6 +22,20 @@ You must have python3.9+ installed to fun this script. Additionally you will nee
To run the application type `python3 e911_helper.py`. The first time you run the application you will receive an error of no-config file found. The system will generate an empty config for you in the same directory called `config.json`. You should configure the parameters here to match your settings and needs. All fields are required.
### Setup Virtual Enviroment.
Setup a virtual enviroment to run your application form.
```
mkdir e911_helper
cd e911_helper
python3 -mvenv venv
```
Activate the virtual enviorment and install required packages
```
source venv/bin/activate
pip install --upgrade pip requests loguru
```
If you are using Windows, you will need to adjust the above commnads to your OS needs.
## Configuration
Edit your `config.json` file and specify your credentials and settings.
**SECUIRTY WARNING**