Add: README.md, heippa.yaml

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87a812f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Contractor -- build software (more) securely
+
+The Contractor lets you build software with less worry that it will
+do something bad. This is an ugly proof of concept prototype and
+certainly not ready for real use.
+
+This will probably only work on Debian 10 (buster) and later. To use,
+you need to have libvirt and vmdb2.
+
+* Create two VM images (this can take a while):  
+
+  `sudo ./vm.sh`
+
+* Create the outer, manager VM:  
+
+  `./vm-libvirt.sh`
+
+* Find out what the IP address of the VM is:  
+
+  `less /var/lib/libvirt/dnsmasq/virbr0.status`
+
+* Clone the test repo:  
+
+  `git clone git://git.liw.fi/heippa /tmp/heippa`
+
+* Build (change IP to yours; this will take a while to run):  
+
+  `./contractor -v -m 192.168.100.63 -- build heippa.yaml`
+
+* Hopefully all went well.
+
+Read contractor.md for more information; formatted versions:
+
+* [HTML](https://files.liw.fi/temp/contractor.html)
+* [PDF](https://files.liw.fi/temp/contractor.pdf)