Skip to content

Commit 03a95ef

Browse files
matkladalexrp
authored andcommitted
Add copy-pastable build instructions
The main value here is to put `CMAKE_GENERATOR=Ninja` front-and-center, so that users realize that extra steps are needed for a parallel build. It _is_ documented quite clearly already, but, from my very personal experience: * people don't read the docs and spend hours hammering one poor core * even if people do read the docs, when the come back to the repo the second time around, they forget, and hammer that single poor core _again_ :-)
1 parent 11e20c3 commit 03a95ef

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ For other versions, check the git tags of this repository.
3737

3838
## Build Instructions
3939

40+
TL;DR:
41+
42+
```
43+
CMAKE_GENERATOR=Ninja ./build native-linux-gnu baseline
44+
./out/zig-x86_64-linux-gnu-baseline/zig version
45+
```
46+
47+
### UNIX Build Instructions
48+
4049
```
4150
./build <arch>-<os>-<abi> <mcpu>
4251
```
@@ -61,7 +70,7 @@ significantly affect how long it takes to build:
6170

6271
When it succeeds, output can be found in `out/zig-<triple>-<cpu>/`.
6372

64-
## Windows Build Instructions
73+
### Windows Build Instructions
6574

6675
Bootstrapping on Windows with MSVC is also possible via `build.bat`, which
6776
takes the same arguments as `build` above.

0 commit comments

Comments
 (0)