From 208724f0a9fcb03ab0a41f970aaaf52d27b0af2b Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Sat, 12 Jun 2021 13:54:08 +0200
Subject: [PATCH] updated README

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 44 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 0b7b7ab..c52a047 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,46 @@
-### How to use this folder
+# TMTC Commander EIVE
 
-This folder contains template files to set up the TMTC commander 
-for a new mission or project. These files are the adaption
-point to customize the TMTC commander.
+# Set up virtual environment
+
+## Linux
+
+1. Create virtual environment
+
+```sh
+python3 -m venv .
+```
+
+2. Activate virtual environment
+
+```sh
+./Scripts/activate
+```
+
+3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
+
+```sh
+cd tmtccmd
+python3 -m pip install -e .[gui]
+```
+
+## Windows
+
+1. Create virtual environment
+
+```sh
+py -m venv .
+```
+
+2. Activate virtual environment
+
+```sh
+Scripts\activate.bat
+```
+
+3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
+
+```sh
+cd tmtccmd
+py -m pip install -e .[gui]
+```
 
-To do so, simply copy all folder inside the TMTC commander root. This
-step is also required because the TMTC commander core will load some modules.