From 5dbe33ceb85b15f27e6722bb907df3ed324b701b Mon Sep 17 00:00:00 2001
From: Robin Mueller <Robin Mueller>
Date: Fri, 11 Mar 2022 11:56:49 +0100
Subject: [PATCH] README update

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 36 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 455cced..6da00db 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,38 @@
 # FSFW Generators
 
-Generic core module to generate various files or databases like the Mission Information Base (MIB),
-returnvalue and event lists, mode tables for on-board software (OBSW) using the
-Flight Software Framework (FSFW)
+Generic Python module to generate source code or information for the
+Flight Software Framework.
+
+Currently, this includes the following helper modules:
+
+1. `events` to generate Event translation source files and CSV lists
+2. `returnvalues` to generate Returnvalue translation source files and CSV lists
+3. `objects` to generate Object ID translation files and CSV lists
+
+## Installing
+
+It is recommended to use a virtual environment
+
+**Linux**
+
+```sh
+python3 -m venv venv
+. venv/bin/activate
+```
+
+**Windows**
+
+```sh
+py -m venv venv
+. venv/bin/activate
+```
+
+Then you can install the package with
+
+```sh
+python -m pip install .
+```
+
+You can add `-e` after `install` to perform an interactive/debug installation.
+This is recommended if you debugging, planning to extend the script or
+performing changes.