From 9e5120231280e3705b8a3cb7a8bb54b5eb422419 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Thu, 20 Aug 2020 13:53:16 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index fa10651..e1534c7 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!
-- 
GitLab