From 1afea36a16ba4963f2a4ad0b2efb5e18680305ac Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Mon, 7 Dec 2020 17:50:14 -0700 Subject: [PATCH] update readme installation instructions The readme now links to the wiki for instructions on building from source. I plan to make many updates to the wiki soon as I start to provide tarballs for working on the compiler. --- README.md | 96 +++---------------------------------------------------- 1 file changed, 5 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 6af21a8067..5eedcdab8b 100644 --- a/README.md +++ b/README.md @@ -14,98 +14,12 @@ A general-purpose programming language and toolchain for maintaining * [Frequently Asked Questions](https://github.com/ziglang/zig/wiki/FAQ) * [Community Projects](https://github.com/ziglang/zig/wiki/Community-Projects) -## Building from Source +## Installation -[![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) - -Note that you can -[download a binary of the master branch](https://ziglang.org/download/#release-master) or -[install Zig from a package manager](https://github.com/ziglang/zig/wiki/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 - - 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 >= 3.15.3 - * Microsoft Visual Studio. Supported versions: - - 2017 (version 15.8) - - 2019 (version 16) - * LLVM, Clang, LLD development libraries == 11.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). - -#### Instructions - -##### POSIX - -``` -mkdir build -cd build -cmake .. -make install -``` - -Need help? [Troubleshooting Build Issues](https://github.com/ziglang/zig/wiki/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 -``` + * [download a pre-built binary](https://ziglang.org/download/) + * [install from a package manager](https://github.com/ziglang/zig/wiki/Install-Zig-from-a-Package-Manager) + * [build from source](https://github.com/ziglang/zig/wiki/Building-Zig-From-Source) + * [bootstrap zig for any target](https://github.com/ziglang/zig-bootstrap) ## License