Skip to content

docs: fix gc tutorial compile and run commands #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hydai merged 1 commit into from
Oct 26, 2026
Merged

docs: fix gc tutorial compile and run commands #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions docs/start/wasmedge/extensions/gc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,24 @@ This is enabled by default in WasmEdge since `0.16.0`. For WasmEdge `0.14.x`–`
## Prerequisites

- WasmEdge `0.14.0` or later. See the [installation guide](https://github.com/WasmEdge/docs/blob/main/docs/start/install.md).
- [`wat2wasm`](https://github.com/WebAssembly/wabt) from the WABT toolkit, to compile `.wat` source files to `.wasm`.
- [`wasm-tools`](https://github.com/bytecodealliance/wasm-tools), to compile `.wat` source files to `.wasm`.

Install WABT on Linux:
Install wasm-tools on Linux (x86_64):

```bash
sudo apt update
sudo apt install -y wabt
curl -LO https://github.com/bytecodealliance/wasm-tools/releases/download/v1.262.0/wasm-tools-1.262.0-x86_64-linux.tar.gz
tar -xzf wasm-tools-1.262.0-x86_64-linux.tar.gz
sudo install wasm-tools-1.262.0-x86_64-linux/wasm-tools /usr/local/bin/wasm-tools
```

Or on macOS:

```bash
brew install wabt
brew install wasm-tools
```

For other platforms, see the [wasm-tools installation instructions](https://github.com/bytecodealliance/wasm-tools#installation).

## Example: Working with Structs

The following WAT (WebAssembly Text Format) example defines a `$point` struct with two `i32` fields, allocates one, sets a field, and returns a value from it.
Expand Down Expand Up @@ -57,13 +60,13 @@ Create a file called `point.wat`:
Compile it to a `.wasm` binary:

```bash
wat2wasm point.wat -o point.wasm
wasm-tools parse point.wat -o point.wasm
```

Run it with WasmEdge:

```bash
wasmedge --invoke make_point point.wasm
wasmedge --reactor point.wasm make_point
```

Expected output:
Expand Down Expand Up @@ -99,8 +102,8 @@ Create a file called `array.wat`:
Compile and run:

```bash
wat2wasm array.wat -o array.wasm
wasmedge --invoke array_example array.wasm
wasm-tools parse array.wat -o array.wasm
wasmedge --reactor array.wasm array_example
```

Expected output:
Expand Down
Loading