summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..916a8cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# 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)
+- Unify package installation across roles (distro-awareness, list as variables, etc)
+- Create own role for installing deps for apt-key (used by several roles, but only installed by docker-ce currently)
+- Rework the whole bwLehrpool background mess