Skip to content

Commit

Permalink
Add README section for docker image (#282)
Browse files Browse the repository at this point in the history
* Add README section for docker image

* Fix package link

* notable limitations caveat
  • Loading branch information
anuraaga authored Jan 13, 2023
1 parent ea58a03 commit 4c06888
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,25 @@ For convenience when building packages that aren't yet updated, updated
config.sub and config.guess files are installed at `share/misc/config.*`
in the install directory.

## Docker Image

We provide a [docker image](https://github.com/WebAssembly/wasi-sdk/pkgs/container/wasi-sdk)
including wasi-sdk that can be used for building projects without a
separate installation of the SDK. Autotools, CMake, and Ninja are included
in this image, and standard environment variables are set to use wask-sdk
for building.

For example, this command can build a make-based project with the Docker
image.

```
docker run -v `pwd`:/src -w /src ghcr.io/webassembly/wasi-sdk make
```

Take note of the [notable limitations](#notable-limitations) below when
building projects, for example many projects will need threads support
disabled in a configure step before building with wasi-sdk.

## Notable Limitations

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

0 comments on commit 4c06888

Please sign in to comment.