diff --git a/README.md b/README.md index fa10651355534bf2492af048ecf7be02e5a87ae4..e1534c7c815ae600c80ac4bd9daa1792a784165a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ TMTC Client ==== +## Cloning the repository +Clone the repository with following command: +```sh +git clone https://git.ksat-stuttgart.de/source/tmtc.git +``` + +Initiate the core components by initiating and updating the submodules +```sh +git submodule init +git submodule sync +git submoduke update +``` + +Install all require packages by running +```sh +pip install -r requirements.txt +``` + +Now the script can be tested by running +```sh +python3 obsw_tmtc_client.py -h +``` + +It is recommended to use and setup PyCharm to also use the preconfigured +run configurations. + + ## Prerequisites Runs with Python 3.8. Don't use Python 2.x!