zig/README.md

105 lines
2.9 KiB
Markdown
Raw Normal View History

2018-05-12 22:07:55 -07:00
![ZIG](https://ziglang.org/zig-logo.svg)
2015-08-05 17:44:05 -07:00
2019-12-30 15:16:40 -08:00
A general-purpose programming language and toolchain for maintaining
**robust**, **optimal**, and **reusable** software.
2015-08-05 17:44:05 -07:00
## Resources
* [Introduction](https://ziglang.org/#Introduction)
* [Download & Documentation](https://ziglang.org/download)
* [Community](https://github.com/ziglang/zig/wiki/Community)
2019-05-28 11:53:01 -07:00
* [Contributing](https://github.com/ziglang/zig/blob/master/CONTRIBUTING.md)
* [Frequently Asked Questions](https://github.com/ziglang/zig/wiki/FAQ)
2019-08-11 13:09:23 -07:00
* [Community Projects](https://github.com/ziglang/zig/wiki/Community-Projects)
2016-11-23 23:44:03 -08:00
## Building from Source
2015-12-06 20:55:28 -08:00
2018-11-06 06: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 08:06:15 -07:00
Note that you can
[download a binary of master branch](https://ziglang.org/download/#release-master).
### Stage 1: Build Zig from C++ Source Code
#### Dependencies
2017-09-25 09:51:26 -07:00
##### POSIX
2016-02-12 13:07:12 -08:00
* cmake >= 2.8.5
2018-01-15 19:17:22 -08:00
* gcc >= 5.0.0 or clang >= 3.6.0
2019-07-16 19:23:48 -07:00
* LLVM, Clang, LLD development libraries == 9.x, compiled with the same gcc or clang version above
- 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).
2017-09-25 09:51:26 -07:00
##### Windows
* 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-25 09:51:26 -07:00
#### Instructions
2015-12-10 14:34:38 -08:00
2018-01-15 19:17:22 -08:00
##### POSIX
2015-12-06 20:55:28 -08:00
```
mkdir build
cd build
cmake ..
2015-12-10 14:34:38 -08:00
make install
2015-12-06 20:55:28 -08:00
```
2015-12-10 14:34:38 -08:00
##### MacOS
2017-09-18 07:47:37 -07:00
```
2019-07-16 19:23:48 -07:00
brew install cmake llvm@9
brew outdated llvm@9 || brew upgrade llvm@9
2017-09-18 07:47:37 -07:00
mkdir build
cd build
2019-08-29 07:14:45 -07:00
cmake .. -DCMAKE_PREFIX_PATH=$(brew --prefix llvm)
2017-09-18 07:47:37 -07:00
make install
```
##### Windows
See https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows
### Stage 2: Build Self-Hosted Zig from Zig Source Code
2015-12-10 14:34:38 -08:00
*Note: Stage 2 compiler is not complete. Beta users of Zig should use the
Stage 1 compiler for now.*
2018-12-18 12:55:00 -08:00
Dependencies are the same as Stage 1, except now you can use stage 1 to compile
Zig code.
2015-12-15 12:06:42 -08:00
2015-12-10 14:34:38 -08:00
```
bin/zig build --prefix $(pwd)/stage2
```
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.
### Stage 3: Rebuild Self-Hosted Zig Using the Self-Hosted Compiler
*Note: Stage 2 compiler is not yet able to build Stage 3. Building Stage 3 is
not yet supported.*
2018-12-18 12: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.
#### Debug / Development Build
```
./stage2/bin/zig build --prefix $(pwd)/stage3
```
#### Release / Install Build
```
./stage2/bin/zig build install -Drelease
2015-12-10 14:34:38 -08:00
```