2018-05-13 13:07:55 +08:00
![ZIG ](https://ziglang.org/zig-logo.svg )
2015-08-06 08:44:05 +08:00
2019-11-14 02:44:19 +08:00
A general-purpose programming language for maintaining **robust** , **optimal** ,
and **reusable** code.
2015-08-06 08:44:05 +08:00
2019-05-04 02:48:56 +08:00
## Resources
2016-02-10 13:31:49 +08:00
2019-05-04 02:48:56 +08:00
* [Introduction ](https://ziglang.org/#Introduction )
* [Download & Documentation ](https://ziglang.org/download )
* [Community ](https://github.com/ziglang/zig/wiki/Community )
2019-05-29 02:53:01 +08:00
* [Contributing ](https://github.com/ziglang/zig/blob/master/CONTRIBUTING.md )
2019-07-03 03:21:03 +08:00
* [Frequently Asked Questions ](https://github.com/ziglang/zig/wiki/FAQ )
2019-08-12 04:09:23 +08:00
* [Community Projects ](https://github.com/ziglang/zig/wiki/Community-Projects )
2016-11-24 15:44:03 +08:00
2019-04-30 06:25:27 +08:00
## Building from Source
2015-12-07 12:55:28 +08:00
2018-11-06 22:55:54 +08:00
[![Build Status ](https://dev.azure.com/ziglang/zig/_apis/build/status/ziglang.zig?branchName=master )](https://dev.azure.com/ziglang/zig/_build/latest?definitionId=1& branchName=master)
2017-04-21 23:06:15 +08:00
2018-11-02 03:21:41 +08:00
Note that you can
[download a binary of master branch ](https://ziglang.org/download/#release-master ).
2017-12-23 13:29:39 +08:00
### Stage 1: Build Zig from C++ Source Code
2016-01-26 12:56:29 +08:00
2017-12-23 13:29:39 +08:00
#### Dependencies
2016-09-06 04:36:21 +08:00
2017-09-26 00:51:26 +08:00
##### POSIX
2016-02-13 05:07:12 +08:00
* cmake >= 2.8.5
2018-01-16 11:17:22 +08:00
* gcc >= 5.0.0 or clang >= 3.6.0
2019-07-17 10:23:48 +08:00
* LLVM, Clang, LLD development libraries == 9.x, compiled with the same gcc or clang version above
2019-04-30 06:25:27 +08:00
- Use the system package manager, or [build from source ](https://github.com/ziglang/zig/wiki/How-to-build-LLVM,-libclang,-and-liblld-from-source#posix ).
2016-09-06 04:36:21 +08:00
2017-09-26 00:51:26 +08:00
##### Windows
2019-09-21 00:54:21 +08:00
* cmake >= 3.15.3
* Microsoft Visual Studio. Supported versions:
- 2015 (version 14)
- 2017 (version 15.8)
- 2019 (version 16)
* LLVM, Clang, LLD development libraries == 9.x
- Use the [pre-built binaries ](https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows ) or [build from source ](https://github.com/ziglang/zig/wiki/How-to-build-LLVM,-libclang,-and-liblld-from-source#windows ).
2017-09-26 00:51:26 +08:00
2017-12-23 13:29:39 +08:00
#### Instructions
2015-12-11 06:34:38 +08:00
2018-01-16 11:17:22 +08:00
##### POSIX
2015-12-07 12:55:28 +08:00
```
mkdir build
cd build
2018-04-11 08:57:37 +08:00
cmake ..
2015-12-11 06:34:38 +08:00
make install
2015-12-07 12:55:28 +08:00
```
2015-12-11 06:34:38 +08:00
2017-12-23 13:29:39 +08:00
##### MacOS
2017-09-18 22:47:37 +08:00
```
2019-07-17 10:23:48 +08:00
brew install cmake llvm@9
brew outdated llvm@9 || brew upgrade llvm@9
2017-09-18 22:47:37 +08:00
mkdir build
cd build
2019-08-29 22:14:45 +08:00
cmake .. -DCMAKE_PREFIX_PATH=$(brew --prefix llvm)
2017-09-18 22:47:37 +08:00
make install
```
2017-12-23 13:29:39 +08:00
##### Windows
2017-10-11 06:04:02 +08:00
2018-05-25 09:27:44 +08:00
See https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows
2017-10-11 06:04:02 +08:00
2017-12-23 13:29:39 +08:00
### Stage 2: Build Self-Hosted Zig from Zig Source Code
2015-12-11 06:34:38 +08:00
2017-12-23 13:29:39 +08:00
*Note: Stage 2 compiler is not complete. Beta users of Zig should use the
Stage 1 compiler for now.*
2018-12-19 04:55:00 +08:00
Dependencies are the same as Stage 1, except now you can use stage 1 to compile
Zig code.
2015-12-16 04:06:42 +08:00
2015-12-11 06:34:38 +08:00
```
2019-07-05 05:43:56 +08:00
bin/zig build --prefix $(pwd)/stage2
2017-12-23 13:29:39 +08:00
```
2017-12-27 08:44:08 +08:00
This produces `./stage2/bin/zig` which can be used for testing and development.
Once it is feature complete, it will be used to build stage 3 - the final compiler
binary.
2017-12-23 13:29:39 +08:00
### Stage 3: Rebuild Self-Hosted Zig Using the Self-Hosted Compiler
2018-05-21 09:59:20 +08:00
*Note: Stage 2 compiler is not yet able to build Stage 3. Building Stage 3 is
not yet supported.*
2018-12-19 04:55:00 +08:00
Once the self-hosted compiler can build itself, this will be the actual
compiler binary that we will install to the system. Until then, users should
use stage 1.
2017-12-23 13:29:39 +08:00
#### Debug / Development Build
```
2019-07-05 05:43:56 +08:00
./stage2/bin/zig build --prefix $(pwd)/stage3
2017-12-23 13:29:39 +08:00
```
#### Release / Install Build
```
2019-07-05 05:43:56 +08:00
./stage2/bin/zig build install -Drelease
2015-12-11 06:34:38 +08:00
```