Skip to content

Commit 6fcafc1

Browse files
Remove wit-bindgen from dependencies and add note about re-bindgen
1 parent b44a609 commit 6fcafc1

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Re-bindgen from `.wit` files
2+
3+
If you update [`*.wit`](https://github.com/WebAssembly/component-model/blob/ed90add27ae845b2e2b9d7db38a966d9f78aa4c0/design/mvp/WIT.md), which describe the interface of a WebAssembly module, either imported or exported, you need to re-generate glue code from `*.wit`.
4+
5+
To re-generate them, you need to install the Rust compiler `rustc` and Cargo, then run `rake check:bindgen`.
6+
7+
The rake task installs [`wit-bindgen`](https://github.com/bytecodealliance/wit-bindgen) on demand, then just execute it for each generated code
8+
9+
If you see `missing executable: cargo`, please make sure `cargo` is installed correctly in your `PATH`.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ If you want to build Ruby for WebAssembly from source yourself, follow the below
6969

7070
### Dependencies
7171

72-
- [wit-bindgen](https://github.com/bytecodealliance/wit-bindgen): A language bindings generator for `wit` used in the npm packages. Install in `PATH`.
7372
- [wasi-sdk](https://github.com/WebAssembly/wasi-sdk): Only for building for WASI target. Set `WASI_SDK_PATH` environment variable to the directory of wasi-sdk.
7473
- [Binaryen](https://github.com/WebAssembly/binaryen): Only for building for WASI target. Install `wasm-opt` in `PATH`
7574
- [wasi-vfs](https://github.com/kateinoigakukun/wasi-vfs): A virtual filesystem layer for WASI. Install CLI tool in `PATH`. Set `LIB_WASI_VFS_A` environment variable to the path to `libwasi_vfs.a`.

0 commit comments

Comments
 (0)