From 0d00938016a75ccf87b50cf55a19b725d01b4ef6 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Thu, 10 Dec 2020 20:17:07 -0700 Subject: [PATCH] update contributing docs --- CONTRIBUTING.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c2e1f09a8..87e1f7ec86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,10 @@ personal project. Here are some great examples: * [Oxid](https://github.com/dbandstra/oxid) - arcade style game * [TM35-Metronome](https://github.com/TM35-Metronome) - tools for modifying and randomizing Pokémon games - * [trOS](https://github.com/sjdh02/trOS) - tiny aarch64 baremetal OS thingy + * [River](https://github.com/ifreund/river/) - a dynamic tiling wayland compositor + +More examples can be found on the +[Community Projects Wiki](https://github.com/ziglang/zig/wiki/Community-Projects). Without fail, these projects lead to discovering bugs and helping flesh out use cases, which lead to further design iterations of Zig. Importantly, each issue @@ -51,7 +54,8 @@ knowledge of Zig internals.** ### Editing Source Code -First, build the Stage 1 compiler as described in [Building from Source](README.md#Building-from-Source). +First, build the Stage 1 compiler as described in +[Building Zig From Source](https://github.com/ziglang/zig/wiki/Building-Zig-From-Source). Zig locates lib files relative to executable path by searching up the filesystem tree for a sub-path of `lib/zig/std/std.zig` or `lib/std/std.zig`. @@ -129,6 +133,14 @@ This will enable running behavior tests and std lib tests with Wine. It's recommended for Linux users to install Wine and enable this testing option when editing the standard library or anything Windows-related. +#### Testing WebAssembly using wasmtime + +If you have [wasmtime](https://wasmtime.dev/) installed, take advantage of the +`-Denable-wasmtime` flag which will enable running WASI behavior tests and std +lib tests. It's recommended for all users to install wasmtime and enable this +testing option when editing the standard library and especially anything +WebAssembly-related. + #### Improving Translate-C Please read the [Editing Source Code](#editing-source-code) section as a