Go to file
Isaac Freund 7b150dd05e docs: snake_case enums/unions in langref examples
This follows the accepted change to the style guide:
https://github.com/ziglang/zig/issues/2101
2020-10-15 18:55:57 +03:00
.builds ci: use hut.lavatech.top for updating the download page 2020-09-14 19:37:59 -07:00
.github Sponsors Button => ZSF 2020-07-11 18:33:56 -04:00
ci ci: macos: unset ZIG_LIBC before testing 2020-10-14 17:59:29 -07:00
cmake Merge remote-tracking branch 'origin/master' into llvm11 2020-10-07 00:46:05 -07:00
deps Revert "Include dbg.h to third-party libs" 2020-10-03 21:29:29 -04:00
doc docs: snake_case enums/unions in langref examples 2020-10-15 18:55:57 +03:00
lib Merge pull request #6655 from kprotty/timers 2020-10-14 21:49:45 -04:00
src Merge pull request #6669 from ifreund/color-fixes 2020-10-14 21:35:43 -04:00
test Merge pull request #6650 from kubkon/macho-incremental 2020-10-14 08:20:33 +02:00
tools tools/update_clang_options: add zig run usage example. fix src-self-hosted path. (#6635) 2020-10-09 23:09:36 -04:00
.gitattributes .gitattributes: deps/SoftFloat-3e/*.txt lines are crlf terminated 2020-04-05 11:03:31 -04:00
.gitignore fix .gitignore file and add commit missing std lib file 2019-02-26 18:33:27 -05:00
CMakeLists.txt ci: macos: update to new cache tarball 2020-10-14 17:36:43 -07:00
CODE_OF_CONDUCT.md add a code of conduct 2020-10-08 22:48:16 -07:00
CONTRIBUTING.md add behavior tests fro macro translations 2020-07-16 17:10:52 +03:00
LICENSE add license 2015-08-05 16:22:18 -07:00
README.md Merge remote-tracking branch 'origin/master' into llvm11 2020-10-12 17:57:35 -07:00
build.zig fix another round of regressions in this branch 2020-09-26 21:03:38 -07:00

README.md

ZIG

A general-purpose programming language and toolchain for maintaining robust, optimal, and reusable software.

Resources

Building from Source

Build Status

Note that you can download a binary of master branch or install Zig from a package manager.

Stage 1: Build Zig from C++ Source Code

This step must be repeated when you make changes to any of the C++ source code.

Dependencies

POSIX
  • cmake >= 2.8.5
  • gcc >= 5.0.0 or clang >= 3.6.0
  • LLVM, Clang, LLD development libraries == 11.x, compiled with the same gcc or clang version above
Windows
  • cmake >= 3.15.3
  • Microsoft Visual Studio. Supported versions:
    • 2017 (version 15.8)
    • 2019 (version 16)
  • LLVM, Clang, LLD development libraries == 11.x

Instructions

POSIX
mkdir build
cd build
cmake ..
make install

Need help? Troubleshooting Build Issues

MacOS
brew install cmake llvm
brew outdated llvm || brew upgrade llvm
mkdir build
cd build
cmake .. -DCMAKE_PREFIX_PATH=$(brew --prefix llvm)
make install
Windows

See https://github.com/ziglang/zig/wiki/Building-Zig-on-Windows

Stage 2: Build Self-Hosted Zig from Zig Source Code

Now we use the stage1 binary:

zig build --prefix $(pwd)/stage2 -Denable-llvm

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

This produces zig-cache/bin/zig.

Release / Install Build

stage2/bin/zig build install -Drelease

License

The ultimate goal of the Zig project is to serve users. As a first-order effect, this means users of the compiler, helping programmers to write better code. Even more important, however, are the end users.

Zig is intended to be used to help end users accomplish their goals. For example, it would be inappropriate and offensive to use Zig to implement dark patterns and it would be shameful to utilize Zig to exploit people instead of benefit them.

However, such problems are best solved with social norms, not with software licenses. Any attempt to complicate the software license of Zig would risk compromising the value Zig provides to users.

Therefore, Zig is available under the MIT (Expat) License, and comes with a humble request: use it to make software better serve the needs of end users.