From 66d788abf4fc52057f1b28ed4186aeaf18ebc159 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 17 May 2022 14:57:54 +0200 Subject: [PATCH] other small update for README --- README.md | 48 ++++++++++++++++++++++++++++-------------------- 1 file changed, 28 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 104d00c..1a32765 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,30 @@ This application can be used to test the EIVE On-Board Software. Furthermore, it 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 and install the `tmtccmd` -package interactively. +The [virtual environemnt](#venv) chapter describes how to set one up. The [requirements](#reqs) +describes how to install all required packages. 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](#venv) and all [package requirements](#reqs) +were installed properly. + +Run CLI mode + +```sh +./tmtccli.py +``` + +Run GUI mode + +```sh +./tmtcgui.py +``` + # Set up virtual environment ## Linux @@ -41,7 +58,7 @@ communication interface. venv\Scripts\activate.bat ``` -# Install requirements +# Install requirements There are two ways to install the requirements. One is to install the primary dependency `tmtccmd` interactively. This is the recommended way @@ -70,23 +87,6 @@ incompatibilities will be high there pip install -r requirements.txt ``` -# Examples - -Assuming you are running in a virtual environment and all package requirements were -installed properly. - -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 @@ -106,3 +106,11 @@ and then run the `lint.py` script ```sh ./lint.py ``` + +# Run Auto-Formatter + +This repo is auto-formatted using `black`. Assuming `black` is installed, you can simply run + +```sh +black . +```