From b5516c8ff47ed02e50821644f788adc14c19ab1c Mon Sep 17 00:00:00 2001
From: Jonathan Bauer
Date: Fri, 17 Mar 2017 16:56:55 +0100
Subject: added basic roles to generate stage3 initramfs

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8768b09..ede4cdc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
 # Ansible roles for OpenSLX
+Small collection of ansible roles to build a dracut-based initramfs for network boot.
+The roles currently support both Ubuntu 16.04.2 and CentOS 7.3.
+Currently, it only matches these distribution families but does not check for these exact versions!
 
+### setup-dev-tools
+Installs basic development packages for the detected distribution:
+
+    Ubuntu:		build-essential, cmake, git
+    CentOS:		"@development tools", cmake, git
+
+### dracut-initramfs-builder
+Builds the dracut-based initramfs using the dnbd3-rootfs module (see [systemd-init](http://git.openslx.org/openslx-ng/systemd-init.git/)):
+* Install needed dependencies to build dracut for the detected distribution
+* Checkout git repository for systemd-init
+* Build the initramfs for the running kernel
+* Extract both initramfs and kernel out of the virtual machine
+
+Depends on *setup-dev-tools* role (see dracut-initramfs-builder/meta/main.yml).
+
+## Usage
+Use the provided 'build-dracut-initramfs.yml' playbook for the ansible provisioner in your packer template.
-- 
cgit v1.2.3-55-g7522