Added documentation to virtualize header

Updated help text as well

1 files changed, 11 insertions, 2 deletions

diff --git a/virtualize b/virtualize
index a82c28b..b0923bf 100755
--- a/virtualize
+++ b/virtualize
@@ -1,9 +1,18 @@
 #!/usr/bin/env bash
+#
+# Provides a very simple "sane" default for quickly virtualizing a system using
+# kvm and qemu. Intended for use to run quick "burn-down" systems for testing
+# (eg: build from live-cd or prebuilt hda using configuration management)
+#
+# Requirements:
+#   qemu
+#   libvirt
 
 if [[ -z ${1} ]]; then
   echo -e "
-Please specify either a system drive to boot (-hda <path>), or a live iso file
-to serve as the bootable virtual cdrom device (-cdrom <path>.iso).\n"
+Please specify at least a system drive to boot (-hda <path>), or a live iso
+file to serve as the bootable virtual cdrom device (-cdrom <path>.iso).\n
+Note that other qemu settings can be passed as well to further customize.\n"
   exit 1
 fi