diff --git a/README.md b/README.md index a79785d..3e56bad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ # TMTC Commander EIVE +This application can be used to test the EIVE On-Board Software. Furthermore, it can +also be used to retrieve all sorts of telemetry data like housekeeping data. + +It is recommended to use this application with a virtual environment. +The [virtual environemnt](#venv) chapter describes how to set one up. + +The configuration file can currently be found at `tmtc_conf.json`. It caches settings +like the default communication interface or parameters like the TCP port when using the TCP +communication interface. + +# Examples + +Assuming you are running in a virtual environment + +Run CLI mode + +```sh +./tmtccli.py +``` + +Run GUI mode + +```sh +./tmtcgui.py +``` + # Run Linter Can be used to quickly check validity of script. Install `flake8` first @@ -20,7 +46,7 @@ and then run the `lint.py` script ./lint.py ``` -# Set up virtual environment +# Set up virtual environment ## Linux @@ -63,4 +89,3 @@ venv\Scripts\activate.bat cd tmtccmd py -m pip install -e .[gui] ``` -