191 lines
7.1 KiB
Markdown
191 lines
7.1 KiB
Markdown
|
|
|
|
Zig is an open-source programming language designed for **robustness**,
|
|
**optimality**, and **maintainability**.
|
|
|
|
## Resources
|
|
|
|
* [Introduction](https://ziglang.org/#Introduction)
|
|
* [Download & Documentation](https://ziglang.org/download)
|
|
* [Community](https://github.com/ziglang/zig/wiki/Community)
|
|
|
|
## Building from Source
|
|
|
|
[](https://dev.azure.com/ziglang/zig/_build/latest?definitionId=1&branchName=master)
|
|
|
|
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
|
|
|
|
##### POSIX
|
|
|
|
* cmake >= 2.8.5
|
|
* gcc >= 5.0.0 or clang >= 3.6.0
|
|
* LLVM, Clang, LLD development libraries == 8.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).
|
|
|
|
##### Windows
|
|
|
|
* cmake >= 2.8.5
|
|
* Microsoft Visual Studio 2017 (version 15.8)
|
|
* LLVM, Clang, LLD development libraries == 8.x, compiled with the same MSVC version above
|
|
- Use the [pre-built binaries](https://github.com/ziglang/zig/wiki/How-to-build-LLVM,-libclang,-and-liblld-from-source#pre-built-binaries) or [build from source](https://github.com/ziglang/zig/wiki/How-to-build-LLVM,-libclang,-and-liblld-from-source#windows).
|
|
|
|
#### Instructions
|
|
|
|
##### POSIX
|
|
|
|
```
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make install
|
|
```
|
|
|
|
##### MacOS
|
|
|
|
```
|
|
brew install cmake llvm@8
|
|
brew outdated llvm@8 || brew upgrade llvm@8
|
|
mkdir build
|
|
cd build
|
|
cmake .. -DCMAKE_PREFIX_PATH=/usr/local/Cellar/llvm/8.0.0
|
|
make install
|
|
```
|
|
|
|
##### Windows
|
|
|
|
See https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows
|
|
|
|
### Stage 2: Build Self-Hosted Zig from Zig Source Code
|
|
|
|
*Note: Stage 2 compiler is not complete. Beta users of Zig should use the
|
|
Stage 1 compiler for now.*
|
|
|
|
Dependencies are the same as Stage 1, except now you can use stage 1 to compile
|
|
Zig code.
|
|
|
|
```
|
|
bin/zig build --build-file ../build.zig --prefix $(pwd)/stage2 install
|
|
```
|
|
|
|
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.*
|
|
|
|
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 --build-file ../build.zig --prefix $(pwd)/stage3 install
|
|
```
|
|
|
|
#### Release / Install Build
|
|
|
|
```
|
|
./stage2/bin/zig build --build-file ../build.zig install -Drelease-fast
|
|
```
|
|
|
|
## Contributing
|
|
|
|
### Start a Project Using Zig
|
|
|
|
One of the best ways you can contribute to Zig is to start using it for a
|
|
personal project. Here are some great examples:
|
|
|
|
* [Oxid](https://github.com/dbandstra/oxid) - arcade style game
|
|
* [TM35-Metronome](https://github.com/TM35-Metronome) - tools for modifying and randomizing Pokémon games
|
|
* [trOS](https://github.com/sjdh02/trOS) - tiny aarch64 baremetal OS thingy
|
|
|
|
Without fail, these projects lead to discovering bugs and helping flesh out use
|
|
cases, which lead to further design iterations of Zig. Importantly, each issue
|
|
found this way comes with real world motivations, so it is easy to explain
|
|
your reasoning behind proposals and feature requests.
|
|
|
|
Ideally, such a project will help you to learn new skills and add something
|
|
to your personal portfolio at the same time.
|
|
|
|
### Spread the Word
|
|
|
|
Another way to contribute is to write about Zig, or speak about Zig at a
|
|
conference, or do either of those things for your project which uses Zig.
|
|
Here are some examples:
|
|
|
|
* [Iterative Replacement of C with Zig](http://tiehuis.github.io/blog/zig1.html)
|
|
* [The Right Tool for the Right Job: Redis Modules & Zig](https://www.youtube.com/watch?v=eCHM8-_poZY)
|
|
|
|
Zig is a brand new language, with no advertising budget. Word of mouth is the
|
|
only way people find out about the project, and the more people hear about it,
|
|
the more people will use it, and the better chance we have to take over the
|
|
world.
|
|
|
|
### Finding Contributor Friendly Issues
|
|
|
|
Please note that issues labeled
|
|
[Proposal](https://github.com/ziglang/zig/issues?q=is%3Aissue+is%3Aopen+label%3Aproposal)
|
|
but do not also have the
|
|
[Accepted](https://github.com/ziglang/zig/issues?q=is%3Aissue+is%3Aopen+label%3Aaccepted)
|
|
label are still under consideration, and efforts to implement such a proposal
|
|
have a high risk of being wasted. If you are interested in a proposal which is
|
|
still under consideration, please express your interest in the issue tracker,
|
|
providing extra insights and considerations that others have not yet expressed.
|
|
The most highly regarded argument in such a discussion is a real world use case.
|
|
|
|
The issue label
|
|
[Contributor Friendly](https://github.com/ziglang/zig/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributor+friendly%22)
|
|
exists to help contributors find issues that are "limited in scope and/or
|
|
knowledge of Zig internals."
|
|
|
|
### Editing Source Code
|
|
|
|
First, build the Stage 1 compiler as described in [the Building section](#building).
|
|
|
|
When making changes to the standard library, be sure to edit the files in the
|
|
`std` directory and not the installed copy in the build directory. If you add a
|
|
new file to the standard library, you must also add the file path in
|
|
CMakeLists.txt.
|
|
|
|
To test changes, do the following from the build directory:
|
|
|
|
1. Run `make install` (on POSIX) or
|
|
`msbuild -p:Configuration=Release INSTALL.vcxproj` (on Windows).
|
|
2. `bin/zig build --build-file ../build.zig test` (on POSIX) or
|
|
`bin\zig.exe build --build-file ..\build.zig test` (on Windows).
|
|
|
|
That runs the whole test suite, which does a lot of extra testing that you
|
|
likely won't always need, and can take upwards of 2 hours. This is what the
|
|
CI server runs when you make a pull request.
|
|
|
|
To save time, you can add the `--help` option to the `zig build` command and
|
|
see what options are available. One of the most helpful ones is
|
|
`-Dskip-release`. Adding this option to the command in step 2 above will take
|
|
the time down from around 2 hours to about 6 minutes, and this is a good
|
|
enough amount of testing before making a pull request.
|
|
|
|
Another example is choosing a different set of things to test. For example,
|
|
`test-std` instead of `test` will only run the standard library tests, and
|
|
not the other ones. Combining this suggestion with the previous one, you could
|
|
do this:
|
|
|
|
`bin/zig build --build-file ../build.zig test-std -Dskip-release` (on POSIX) or
|
|
`bin\zig.exe build --build-file ..\build.zig test-std -Dskip-release` (on Windows).
|
|
|
|
This will run only the standard library tests, in debug mode only, for all
|
|
targets (it will cross-compile the tests for non-native targets but not run
|
|
them).
|
|
|
|
When making changes to the compiler source code, the most helpful test step to
|
|
run is `test-behavior`. When editing documentation it is `docs`. You can find
|
|
this information and more in the `--help` menu.
|