zig/README.md

78 lines
2.5 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-10-01 23:11:46 -07:00
* LLVM, Clang, LLD development libraries == 10.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)
2019-10-01 23:11:46 -07:00
* LLVM, Clang, LLD development libraries == 10.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
Need help? [Troubleshooting Build Issues](https://github.com/ziglang/zig/wiki/Troubleshooting-Build-Issues)
##### MacOS
2017-09-18 07:47:37 -07:00
```
brew install cmake llvm
brew outdated llvm || brew upgrade llvm
2017-09-18 07:47:37 -07:00
mkdir build
cd build
cmake .. -DCMAKE_PREFIX_PATH=$(brew --prefix llvm)
2020-07-02 21:43:05 -07:00
make install
2017-09-18 07:47:37 -07:00
```
You will now run into this issue:
[homebrew and llvm 10 packages in apt.llvm.org are broken with undefined reference to getPollyPluginInfo](https://github.com/ziglang/zig/issues/4799)
2020-07-02 21:43:05 -07:00
or
[error: unable to create target: 'Unable to find target for this triple (no targets are registered)'](https://github.com/ziglang/zig/issues/5055),
in which case try `-DZIG_WORKAROUND_4799=ON`
2020-07-02 21:43:05 -07:00
Hopefully this will be fixed upstream with LLVM 10.0.1.
##### Windows
See https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows