From 955e96226184a9b7c9579a37af35451841f156f7 Mon Sep 17 00:00:00 2001
From: Jonathan Bauer
Date: Wed, 19 May 2021 10:44:16 +0200
Subject: README.md: update and remove old README

---
 README    |  9 ---------
 README.md | 20 ++++++++++++++++++++
 2 files changed, 20 insertions(+), 9 deletions(-)
 delete mode 100644 README

diff --git a/README b/README
deleted file mode 100644
index 67953eb..0000000
--- a/README
+++ /dev/null
@@ -1,9 +0,0 @@
-Collection of small roles to use mltk to build and install the bwLehrool environment.
-
-Split between:
-* mltk-core: just sets the git repository variables, depended by other mltk related roles
-* mltk-bwlp: builds and installs the bwlp mltk target
-* mltk-nvidia: builds and installed the nvidia as mltk addon
-
-Main playbook:
-* setup-bwlp.yml
diff --git a/README.md b/README.md
index 6993de4..e909fb1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
+# Collection of small roles to use mltk to build and install the bwLehrool environment.
+
+## Playbook
+
+You should used the 'setup-bwlp.yml' playbook. It supports two tags:
+
+- core: the basic bwLehrpool flavour with just xfce4 and basic tools
+- extended: the Freiburg bwLehrpool flavour with kde-plasma, ubuntu-desktio, i3 and extended tools
+
+## mltk roles
+
+- mltk-core: just sets the git repository variables, depended by other mltk related roles
+- mltk-bwlp: builds and installs the bwlp mltk target
+- mltk-vmware: builds and installs the vmware mltk addons
+- mltk-nvidia: builds and installs the nvidia mltk addons
+
+## other roles
+
+TODO
+
 # ToDo list
 
 - Unify variables declaration across roles (sometimes defaults/ and sometimes vars/ is used)
-- 
cgit v1.2.3-55-g7522