github/linuxkit
1
0
Fork 0
mirror of https://github.com/linuxkit/linuxkit.git synced 2025-07-20 01:29:07 +00:00
Code Issues Projects Releases Wiki Activity

Slighly clearer getting started docs

Browse Source 
Signed-off-by: Justin Cormack <justin.cormack@docker.com>
This commit is contained in:
Justin Cormack 2017-06-26 17:40:34 +01:00
parent 50785b4be7
commit d573e37fec
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -33,14 +33,21 @@ brew install --HEAD moby
brew install --HEAD linuxkit brew install --HEAD linuxkit
``` ```
Once you have built the tool, use `moby build linuxkit.yml` to build the example configuration, Build requirements from source:
and `linuxkit run linuxkit` to run locally. Use `halt` to terminate on the console.
Build requirements:
- GNU `make` - GNU `make`
- Docker - Docker
- optionally `qemu` - 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 ### Booting and Testing
You can use `linuxkit run <name>` or `linuxkit run <name>.<format> to execute the image you created with `moby build <name>.yml`. You can use `linuxkit run <name>` or `linuxkit run <name>.<format> to execute the image you created with `moby build <name>.yml`.