Initial packer/vagrant/autotest setup

[grml-debootstrap.git] / packer / README.md

diff --git a/packer/README.md b/packer/README.md
new file mode 100644 (file)
index 0000000..119a97f
--- /dev/null
+++ b/packer/README.md
@@ -0,0 +1,30 @@
+Creating Vagrant baseboxes and testing grml-debootstrap
+=======================================================
+
+Purpose
+-------
+
+This directory provides configurations and scripts to
+
+* test grml-debootstrap
+* generate base.box for Virtualbox usage with Vagrant
+
+Required software
+-----------------
+
+* [Packer](http://packer.io/) binary in $PATH
+* [Vagrant](http://vagrantup.com/)
+* [Virtualbox](https://www.virtualbox.org/)
+
+Usage instructions
+------------------
+
+To create a Debian base box for usage with Vagrant
+(and while at it run the grml-debootstrap tests):
+
+    % cd grml-debootstrap.git
+    % make testrun
+
+Start resulting Debian system via Vagrant:
+
+    % vagrant up