eive/eive-tmtc
eive/eive-tmtc
14
0
Fork 0
Code Issues Pull Requests 1 Projects Releases 98 Wiki Activity

other small update for README

Browse Source
This commit is contained in:
Robin Müller 2022-05-17 14:57:54 +02:00
parent 1272a5aa89
commit 66d788abf4
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
1 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -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. also be used to retrieve all sorts of telemetry data like housekeeping data.
It is recommended to use this application with a virtual environment. 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` The [virtual environemnt](#venv) chapter describes how to set one up. The [requirements](#reqs)
package interactively. describes how to install all required packages.
The configuration file can currently be found at `tmtc_conf.json`. It caches settings 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 like the default communication interface or parameters like the TCP port when using the TCP
communication interface. 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
```
# <a id="venv"></a> Set up virtual environment # <a id="venv"></a> Set up virtual environment
## Linux ## Linux
@ -41,7 +58,7 @@ communication interface.
venv\Scripts\activate.bat venv\Scripts\activate.bat
``` ```
# Install requirements # <a id="reqs"></a> Install requirements
There are two ways to install the requirements. One is to install the primary dependency There are two ways to install the requirements. One is to install the primary dependency
`tmtccmd` interactively. This is the recommended way `tmtccmd` interactively. This is the recommended way
@ -70,23 +87,6 @@ incompatibilities will be high there
pip install -r requirements.txt 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 # Run Linter
Can be used to quickly check validity of script. Install `flake8` first Can be used to quickly check validity of script. Install `flake8` first
@ -106,3 +106,11 @@ and then run the `lint.py` script
```sh ```sh
./lint.py ./lint.py
``` ```
# Run Auto-Formatter
This repo is auto-formatted using `black`. Assuming `black` is installed, you can simply run
```sh
black .
```