authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-04-29 17:38:03-04:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-04-29 17:38:03-04:00
logfe80c15c4b2c436921f77fecb11081c3bb6d7e8a
tree80b47e229f37ee6e4aac2b3e426ebfa62e904abe
parenta4e506510b202685d859e366feeeb76e09252ba0
parent6936f0514f1fb2625bdaa070dccc5bd3ef23d377
signaturelock-open Commit is signed but in an unrecognized format.

Merge branch 'readme-std-lib' of https://github.com/squeek502/zig into squeek502-readme-std-lib


1 files changed, 23 insertions(+), 0 deletions(-)

README.md+23
...@@ -223,3 +223,26 @@ use stage 1....@@ -223,3 +223,26 @@ use stage 1.
223```223```
224./stage2/bin/zig build --build-file ../build.zig install -Drelease-fast224./stage2/bin/zig build --build-file ../build.zig install -Drelease-fast
225```225```
226
227## Developing Zig
228
229### Standard Library
230
231First, build the Stage 1 compiler as described in [the Building section](#building).
232Then, make your changes to the standard library files in `std` (note: not
233`build/lib/zig/std`). To test changes to the standard library, do the following
234from the build directory:
235
2361. Run `make install` (on POSIX) or `msbuild -p:Configuration=Release INSTALL.vcxproj`
237 (on Windows).
2382. Test your changes with `bin/zig test lib/zig/std/<changed file>` (e.g. `bin/zig test lib/zig/std/heap.zig`).
239
240Once your changes are finished, run all the zig tests from the build directory:
241
242```
243bin/zig build --build-file ../build.zig test -Dskip-release
244```
245
246*Note: The `-Dskip-release` flag will skip running the longer test process that tests
247all possible build configurations. This shorter test process is good enough when
248submitting pull requests*