summaryrefslogtreecommitdiff
path: root/index.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'index.mdwn')
-rw-r--r--index.mdwn30
1 files changed, 29 insertions, 1 deletions
diff --git a/index.mdwn b/index.mdwn
index 44a6e5a..96a9f87 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,5 +1,33 @@
[[!meta title="vmadm"]]
[[Download]] —
-[[Documentation|docs]] —
[[Contact]]
+
+vmadm is a tool to create and destroy virtual machines running
+under a local libvirt. Virtual machines are described in specification
+files, using YAML:
+
+~~~yaml
+foo:
+ cpus: 4
+ memory_mib: 4096
+ image_size_gib: 100
+
+bar:
+ cpus: 1
+ memory_mib: 512
+ image_size_gib: 1
+~~~
+
+All the machines in a specification file are created or destroyed at
+once.
+
+# Acceptance criteria
+
+See acceptance criteria and verification as
+[HTML](https://doc.liw.fi/vmadm/vmadm.html) and
+[PDF](https://doc.liw.fi/vmadm/vmadm.pdf).
+
+# License
+
+GNU General License (GPL) version 3 or later.