Change: README.md to be ready for public announcement

1 files changed, 47 insertions, 6 deletions

diff --git a/README.md b/README.md
index 83f4c9a..92ca8dd 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,47 @@ you need to have libvirt, virt-install, and vmdb2, and several
 gigabytes of disk space, RAM, and CPUs, and fair bit of bandwidth.
 Possibly other things.
 
-* Edit Ansible playbook to set `user_pub` to your SSH public key:  
+## Use pre-built images
+
+Warning: the uncompressed files are big. You need at least a few tens
+of gigabytes of free disk space. If you build your own images, you can
+do with less disk space.
+
+* Clone this source repository:  
+
+  `git clone https://gitlab.com/larswirzenius/contractor.git`  
+  `cd contractor`
+
+* Download manager and worker VM images and uncompress them:  
+
+  `curl https://files.liw.fi/contractor/vm.img.xz > vm.img.xz`  
+  `curl https://files.liw.fi/contractor/worker.img.xz > worker.img.xz`  
+  `unxz -v *.img.xz`
+
+* Change the manager to accept your own SSH public:  
+
+  `sudo sh -x ./set-authorized-key vm.img ~/.ssh/id*.pub`
+
+* Create a workspace disk image:  
+
+  `truncate -s 50G workspace.img`
+
+* Create manager VM:  
+
+  `./vm-libvirt.sh vm.img workspace.img`
+
+  This step requires libvirt and virt-installer installed.
+
+
+## Build everything yourself
+
+[vmdb2]: https://vmdb2.liw.fi/
+
+This step gives you exactly the images you want, but requires having
+the [vmdb2][] tool installed.
+
+* Edit Ansible playbook to set `user_pub` to your SSH public key, and
+  any other things you want to change such as size of the image:  
 
   `editor vm.yml`
 
@@ -27,7 +67,7 @@ Possibly other things.
 
 * Check that the manager VM is accessibler (change IP to yours):  
 
-  `./contractor -m 192.168.100.63 manager-status`
+  `./contractor -m 192.168.122.63 manager-status`
 
 * Clone the test repo:  
 
@@ -35,9 +75,11 @@ Possibly other things.
 
 * Build (change IP to yours; this will take a while to run):  
 
-  `./contractor -v -m 192.168.100.63 -- build heippa.yaml`
+  `./contractor -v -m 192.168.122.63 -- build heippa.yaml`
 
-  Add a `--log contractor.log` option to have a log file.
+  Add a `--log contractor.log` option to have a log file. It sometimes
+  helps for debugging. The output from the build commands goes to the
+  stdout and stderr of contactor, not the log file.
 
 * Hopefully all went well.
 
@@ -49,8 +91,7 @@ Read contractor.md for more information; formatted versions:
 If you think this is project is worthwhile, and would like to help,
 please get in touch!
 
-Lars Wirzenius, liw@liw.fi
-
 ---
 title: README for Contractor
+author: Lars Wirzenius (liw@liw.fi)
 ...