From d573e37fec1e1256b5abe4bc68b40de1508a1b13 Mon Sep 17 00:00:00 2001 From: Justin Cormack Date: Mon, 26 Jun 2017 17:40:34 +0100 Subject: [PATCH] Slighly clearer getting started docs Signed-off-by: Justin Cormack --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 99e8fac99..dc5d158d1 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,21 @@ brew install --HEAD moby brew install --HEAD linuxkit ``` -Once you have built the tool, use `moby build linuxkit.yml` to build the example configuration, -and `linuxkit run linuxkit` to run locally. Use `halt` to terminate on the console. - -Build requirements: +Build requirements from source: - GNU `make` - Docker - optionally `qemu` +### Building images + +Once you have built the tool, use + +``` +moby build linuxkit.yml +``` +to build the example configuration. You can also specify different output formats, eg `moby build -output raw linuxkit.yml` to +output a raw bootable disk image. See `moby build -help` for more information. + ### Booting and Testing You can use `linuxkit run ` or `linuxkit run . to execute the image you created with `moby build .yml`.