From 2e6097c13106d0033b0e8c6ad0e08e4b842a32e4 Mon Sep 17 00:00:00 2001 From: Kohei Tokunaga Date: Fri, 12 Jan 2024 15:38:29 +0900 Subject: [PATCH] fix docs Signed-off-by: Kohei Tokunaga --- README.md | 11 ++++++----- examples/no-conversion/README.md | 2 ++ extras/imagemounter/README.md | 6 ++++-- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0be45a4..ba3e9e2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[[:arrow_down: **Download**]](https://github.com/ktock/container2wasm/releases) -[[:book: **Command reference**]](#command-reference) -[[:books: **Additional Documents**]](#additional-resources) -[[:arrow_forward: **Demo**]](https://ktock.github.io/container2wasm-demo/) +[[⬇️**Download**]](https://github.com/ktock/container2wasm/releases) +[[📖 **Command reference**]](#command-reference) +[[📚 **Additional Documents**]](#additional-resources) +[[▶️**Demo**]](https://ktock.github.io/container2wasm-demo/) # container2wasm: Container to WASM converter @@ -200,6 +200,7 @@ Options - `--debug-image`: Enable debug print in the output image - `--show-dockerfile`: Show default Dockerfile - `--legacy`: Use "docker build" instead of buildx (no support for assets flag) (default:false) +- `--external-bundle`: Do not embed container image to the Wasm image but mount it during runtime - `--help, -h`: show help - `--version, -v: `print the version @@ -310,7 +311,7 @@ Re-compilation (and possibe re-implementation) of the application is needed. - [`./examples/`](./examples): Examples (python, php, on-browser, networking, etc.) - `vscode-container-wasm`: VSCode extension for running containers on VSCode on browser (e.g. `github.dev`), leveraging container2wasm: https://github.com/ktock/vscode-container-wasm -- [`./extras/imagemounter`]: A helper tool for enabling to distributing and running container images on browser without pre-conversion of the images. +- [`./extras/imagemounter`](./extras/imagemounter/): A helper tool for enabling to distributing and running container images on browser without pre-conversion of the images. ## Acknowledgement diff --git a/examples/no-conversion/README.md b/examples/no-conversion/README.md index f50ed74..2b20816 100644 --- a/examples/no-conversion/README.md +++ b/examples/no-conversion/README.md @@ -14,6 +14,8 @@ The following outputs a Wasm image `out.wasm` that contains runc + Linux + CPU e $ c2w --external-bundle out.wasm ``` +> container2wasm >= 0.6.0 is needed. + Then, put a container image to the server in the standard [OCI Image Layout](https://github.com/opencontainers/image-spec/blob/v1.0.2/image-layout.md). The following puts `ubuntu:22.04` container image to `/tmp/imageout/`. diff --git a/extras/imagemounter/README.md b/extras/imagemounter/README.md index 129617e..6660c5f 100644 --- a/extras/imagemounter/README.md +++ b/extras/imagemounter/README.md @@ -32,11 +32,13 @@ As of now, the following image server is supported: First, build basic dependencies: ```console -$ make imagemounter.wasm c2w $ mkdir /tmp/outx/ -$ ./out/c2w --external-bundle /tmp/outx/out.wasm +$ c2w --external-bundle /tmp/outx/out.wasm +$ make imagemounter.wasm ``` +> container2wasm >= 0.6.0 is needed. + ### Example on browser + HTTP Server The following pulls `ubuntu:22.04` stored at https://ktock.github.io/ubuntu-oci-images/ubuntu-22.04-org-amd64 as [OCI Image Layout](https://github.com/opencontainers/image-spec/blob/v1.0.2/image-layout.md) and runs it on Wasm.