diff --git a/README.md b/README.md index ec14746..b23d263 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # FieldPOC A simple to use, good enough phone system for medium sized DECT networks. + +## Development setup + +Make sure you have [mitel_ommclient2]() in your Python modules path. + +Add user credentials to your OMM to `fieldpoc_config.json`. + +Edit `fieldpoc_extensions.json` to meet your preferences. + +Start FieldPOC: + +``` +python -m fieldpoc.run +``` + +List some options: + +``` +python -m fieldpoc.run --help +```