authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-12-10 20:17:07-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-12-10 20:17:07-07:00
log0d00938016a75ccf87b50cf55a19b725d01b4ef6
treed010bce39b6539f3a8173ccaf62266f5165ae80d
parentf7d600675c548b4e45b24f8e10ebdd892a6b8dba

update contributing docs


1 files changed, 14 insertions(+), 2 deletions(-)

CONTRIBUTING.md+14-2
......@@ -7,7 +7,10 @@ personal project. Here are some great examples:
77
88 * [Oxid](https://github.com/dbandstra/oxid) - arcade style game
99 * [TM35-Metronome](https://github.com/TM35-Metronome) - tools for modifying and randomizing Pokémon games
10 * [trOS](https://github.com/sjdh02/trOS) - tiny aarch64 baremetal OS thingy
10 * [River](https://github.com/ifreund/river/) - a dynamic tiling wayland compositor
11
12More examples can be found on the
13[Community Projects Wiki](https://github.com/ziglang/zig/wiki/Community-Projects).
1114
1215Without fail, these projects lead to discovering bugs and helping flesh out use
1316cases, which lead to further design iterations of Zig. Importantly, each issue
......@@ -51,7 +54,8 @@ knowledge of Zig internals.**
5154
5255### Editing Source Code
5356
54First, build the Stage 1 compiler as described in [Building from Source](README.md#Building-from-Source).
57First, build the Stage 1 compiler as described in
58[Building Zig From Source](https://github.com/ziglang/zig/wiki/Building-Zig-From-Source).
5559
5660Zig locates lib files relative to executable path by searching up the
5761filesystem 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
129133recommended for Linux users to install Wine and enable this testing option
130134when editing the standard library or anything Windows-related.
131135
136#### Testing WebAssembly using wasmtime
137
138If you have [wasmtime](https://wasmtime.dev/) installed, take advantage of the
139`-Denable-wasmtime` flag which will enable running WASI behavior tests and std
140lib tests. It's recommended for all users to install wasmtime and enable this
141testing option when editing the standard library and especially anything
142WebAssembly-related.
143
132144#### Improving Translate-C
133145
134146Please read the [Editing Source Code](#editing-source-code) section as a