Skip to content

Commit 4c06888

Browse files
authored
Add README section for docker image (#282)
* Add README section for docker image * Fix package link * notable limitations caveat
1 parent ea58a03 commit 4c06888

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,25 @@ For convenience when building packages that aren't yet updated, updated
8181
config.sub and config.guess files are installed at `share/misc/config.*`
8282
in the install directory.
8383

84+
## Docker Image
85+
86+
We provide a [docker image](https://github.com/WebAssembly/wasi-sdk/pkgs/container/wasi-sdk)
87+
including wasi-sdk that can be used for building projects without a
88+
separate installation of the SDK. Autotools, CMake, and Ninja are included
89+
in this image, and standard environment variables are set to use wask-sdk
90+
for building.
91+
92+
For example, this command can build a make-based project with the Docker
93+
image.
94+
95+
```
96+
docker run -v `pwd`:/src -w /src ghcr.io/webassembly/wasi-sdk make
97+
```
98+
99+
Take note of the [notable limitations](#notable-limitations) below when
100+
building projects, for example many projects will need threads support
101+
disabled in a configure step before building with wasi-sdk.
102+
84103
## Notable Limitations
85104

86105
This repository does not yet support C++ exceptions. C++ code is

0 commit comments

Comments
 (0)