summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-06-22 18:22:10 +0300
committerLars Wirzenius <liw@liw.fi>2023-06-22 18:22:10 +0300
commit474eaa68c8d87d4837e78503d385c89484008a10 (patch)
treec8c458716e11cded18d3c01657ec66120f337220
parent19e646105148f0957e4a8b25573295994efee04a (diff)
downloadambient-ci-474eaa68c8d87d4837e78503d385c89484008a10.tar.gz
docs: update README to match the software
Sponsored-by: author
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index d4a05da..44587db 100644
--- a/README.md
+++ b/README.md
@@ -4,20 +4,19 @@ Ambient is a PRE-ALPHA level project to build a CI system. It's only
ever been tested on Debian 12 (bookworm). To try this:
- you need: vmdb2, ansible, QEMU, possibly more
-- build the VM image: `sudo ./runner.sh /var/tmp ambient.qcow2`
+- build the VM image:
+ `sudo ./ambient-build-debian-image --image ~/ambient.qcow2--cache ~`
- building an image requires root access, but you can re-use the
image any number of times, and you only need to build it once
- - the first argument is a directory where a cache file is created to
- speed up future builds
- - the second argument is the name of the finished VM image
- - on my machine the first build takes minutes, subsequent builds
- take about 30s
+ - the cache option names a directory where a cache file is created
+ to speed up future builds
+ - the image option is the name of the finished VM image
+ - this can take a few minutes
- run a build: `./ambient-run --image ambient.qcow2 --log log --artifact output.tar test-project`
- this builds the project in `test-project` in a VM, by running
`test-project/.ambient-script`
- this will write the build log to `log` and any artifacts produced
by the build to `output.tar`
- - on my machine the build takes about 30s
## Links