Go to file
Andrew Kelley f5a67dba08 self-hosted: implicit cast comptime ints to other ints
we now have successful exit codes from main linking
against libc
2018-07-20 01:46:49 -04:00
c_headers update C headers to clang 6.0.0rc3 2018-02-23 13:15:16 -05:00
ci appveyor: remove llvm 5.0.1 from cache 2018-06-01 12:22:53 -04:00
cmake add ZIG_STATIC cmake option 2018-03-30 13:20:13 -04:00
deps LLD patch: Do not keep shared symbols to garbage... 2018-04-11 18:15:33 -04:00
doc Fixed minor documentation errors (#1256) 2018-07-17 21:18:41 -04:00
example update more tests 2018-06-17 12:33:24 -04:00
src Allow pointers to anything in extern/exported declarations (#1258) 2018-07-18 11:00:42 -04:00
src-self-hosted self-hosted: implicit cast comptime ints to other ints 2018-07-20 01:46:49 -04:00
std self-hosted: implicit cast comptime ints to other ints 2018-07-20 01:46:49 -04:00
test self-hosted: implicit cast comptime ints to other ints 2018-07-20 01:46:49 -04:00
.gitattributes Do not normalize langref.html.in line endings 2018-07-04 23:47:15 +12:00
.gitignore gitignore docgen test artifacts 2018-07-01 13:47:29 -04:00
.travis.yml travis: use encrypted env vars for s3 credentials 2018-04-22 12:33:02 -04:00
CMakeLists.txt self-hosted: progress on IR for supporting libc hello world 2018-07-19 00:08:47 -04:00
LICENSE add license 2015-08-05 16:22:18 -07:00
README.md std.zig.parse: fix treating integer literals as string literals 2018-07-18 17:56:34 -04:00
build.zig -Dskip-release now also skips build example tests 2018-07-18 10:28:14 +02:00

README.md

ZIG

A programming language designed for robustness, optimality, and clarity.

ziglang.org

Feature Highlights

  • Small, simple language. Focus on debugging your application rather than debugging knowledge of your programming language.
  • Ships with a build system that obviates the need for a configure script or a makefile. In fact, existing C and C++ projects may choose to depend on Zig instead of e.g. cmake.
  • A fresh take on error handling which makes writing correct code easier than writing buggy code.
  • Debug mode optimizes for fast compilation time and crashing with a stack trace when undefined behavior would happen.
  • ReleaseFast mode produces heavily optimized code. What other projects call "Link Time Optimization" Zig does automatically.
  • Compatible with C libraries with no wrapper necessary. Directly include C .h files and get access to the functions and symbols therein.
  • Provides standard library which competes with the C standard library and is always compiled against statically in source form. Zig binaries do not depend on libc unless explicitly linked.
  • Optional type instead of null pointers.
  • Safe unions, tagged unions, and C ABI compatible unions.
  • Generics so that one can write efficient data structures that work for any data type.
  • No header files required. Top level declarations are entirely order-independent.
  • Compile-time code execution. Compile-time reflection.
  • Partial compile-time function evaluation which eliminates the need for a preprocessor or macros.
  • The binaries produced by Zig have complete debugging information so you can, for example, use GDB, MSVC, or LLDB to debug your software.
  • Built-in unit tests with zig test.
  • Friendly toward package maintainers. Reproducible build, bootstrapping process carefully documented. Issues filed by package maintainers are considered especially important.
  • Cross-compiling is a primary use case.
  • In addition to creating executables, creating a C library is a primary use case. You can export an auto-generated .h file.

Support Table

Freestanding means that you do not directly interact with the OS or you are writing your own OS.

Note that if you use libc or other libraries to interact with the OS, that counts as "freestanding" for the purposes of this table.

freestanding linux macosx windows other
i386 OK planned OK planned planned
x86_64 OK OK OK OK planned
arm OK planned planned N/A planned
aarch64 OK planned N/A planned planned
bpf OK planned N/A N/A planned
hexagon OK planned N/A N/A planned
mips OK planned N/A N/A planned
powerpc OK planned N/A N/A planned
r600 OK planned N/A N/A planned
amdgcn OK planned N/A N/A planned
sparc OK planned N/A N/A planned
s390x OK planned N/A N/A planned
thumb OK planned N/A N/A planned
spir OK planned N/A N/A planned
lanai OK planned N/A N/A planned

Community

Wanted: Windows Developers

Flesh out the standard library for Windows, streamline Zig installation and distribution for Windows. Work with LLVM and LLD teams to improve PDB/CodeView/MSVC debugging. Implement stack traces for Windows in the MinGW environment and the MSVC environment.

Wanted: MacOS and iOS Developers

Flesh out the standard library for MacOS. Improve the MACH-O linker. Implement stack traces for MacOS. Streamline the process of using Zig to build for iOS.

Wanted: Android Developers

Flesh out the standard library for Android. Streamline the process of using Zig to build for Android and for depending on Zig code on Android.

Wanted: Web Developers

Figure out what are the use cases for compiling Zig to WebAssembly. Create demo projects with it and streamline experience for users trying to output WebAssembly. Work on the documentation generator outputting useful searchable html documentation. Create Zig modules for common web tasks such as WebSockets and gzip.

Wanted: Embedded Developers

Flesh out the standard library for uncommon CPU architectures and OS targets. Drive issue discussion for cross compiling and using Zig in constrained or unusual environments.

Wanted: Game Developers

Create cross platform Zig modules to compete with SDL and GLFW. Create an OpenGL library that does not depend on libc. Drive the usability of Zig for video games. Create a general purpose allocator that does not depend on libc. Create demo games using Zig.

Building

Build Status Build status

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 == 6.x, compiled with the same gcc or clang version above
    • These depend on zlib and libxml2.
Windows
  • cmake >= 2.8.5
  • Microsoft Visual Studio 2015
  • LLVM, Clang, LLD development libraries == 6.x, compiled with the same MSVC version above

Instructions

POSIX
mkdir build
cd build
cmake ..
make
make install
bin/zig build --build-file ../build.zig test
MacOS
brew install cmake llvm@6
brew outdated llvm@6 || brew upgrade llvm@6
mkdir build
cd build
cmake .. -DCMAKE_PREFIX_PATH=/usr/local/opt/llvm@6/
make install
bin/zig build --build-file ../build.zig test
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 have a working zig compiler.

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

This is the actual compiler binary that we will install to the system.

Note: Stage 2 compiler is not yet able to build Stage 3. Building Stage 3 is not yet supported.

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