gitback/zig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Andrew Kelley 2019-04-29 17:38:03 -04:00
commit fe80c15c4b
No known key found for this signature in database
GPG Key ID: 7C5F548F728501A9
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -223,3 +223,26 @@ use stage 1.
```
./stage2/bin/zig build --build-file ../build.zig install -Drelease-fast
```
## Developing Zig
### Standard Library
First, build the Stage 1 compiler as described in [the Building section](#building).
Then, make your changes to the standard library files in `std` (note: not
`build/lib/zig/std`). To test changes to the standard library, do the following
from the build directory:
1. Run `make install` (on POSIX) or `msbuild -p:Configuration=Release INSTALL.vcxproj`
(on Windows).
2. Test your changes with `bin/zig test lib/zig/std/<changed file>` (e.g. `bin/zig test lib/zig/std/heap.zig`).
Once your changes are finished, run all the zig tests from the build directory:
```
bin/zig build --build-file ../build.zig test -Dskip-release
```
*Note: The `-Dskip-release` flag will skip running the longer test process that tests
all possible build configurations. This shorter test process is good enough when
submitting pull requests*