From 8cbb358c8f5ba53b9f89e52fe507c83293002b39 Mon Sep 17 00:00:00 2001
From: Kamil Páral <kparal@redhat.com>
Date: Apr 24 2015 11:37:01 +0000
Subject: add readme


A solid foundation for any project.

---

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..d6f9865
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,19 @@
+Taskotron VM Builder
+====================
+
+*This is a proof of concept code, don't rely on this.*
+
+Taskotron VM Builder should provide an easy way to create customized virtual
+machines to be used in Taskotron as disposable clients. The machine will be
+built according to specified parameters, mainly:
+
+ * contain a requested set of up-to-date packages
+ * have libtaskotron installed
+ * have user accounts configured
+ * have remote logging capabilities configured (ssh, serial console)
+
+This image can then be snapshotted and used to spawn virtual machines, throwing
+away any disk changes before each new boot.
+
+If historical images are archived, they can provide a way to have reproducible
+environment for re-executing tasks.