update README

This commit is contained in:
Mitchell Hashimoto
2024-04-21 10:30:22 -07:00
parent 99b963d4b0
commit e045e6635b

View File

@ -430,7 +430,7 @@ expand this to other platforms.
## Developing Ghostty ## Developing Ghostty
To build Ghostty, you need [Zig](https://ziglang.org/) installed. To build Ghostty, you need [Zig 0.12](https://ziglang.org/) installed.
On Linux, you may need to install additional dependencies. See On Linux, you may need to install additional dependencies. See
[Linux Installation Tips](#linux-installation-tips). On macOS, you [Linux Installation Tips](#linux-installation-tips). On macOS, you
@ -444,18 +444,12 @@ Ghostty must pass within these Nix environments.
> [!NOTE] > [!NOTE]
> >
> **Zig nightly is required.** Ghostty is built against the nightly > **Zig 0.12 is required.** Ghostty only guarantees that it can build
> releases of Zig while it is still in beta. I plan on stabilizing on a release > against 0.12. Zig is still a fast-moving project so it is likely newer
> version when I get closer to generally releasing this to ease downstream > versions will not be able to build Ghostty yet. You can find binary
> packagers. You can find binary releases of nightly builds on the > releases of Zig release builds on the
> [Zig downloads page](https://ziglang.org/download/). > [Zig downloads page](https://ziglang.org/download/).
Under some conditions, the very latest Zig nightly may not work (for example,
when Zig introduces breaking changes that Ghostty or our dependencies haven't
been upated for). To be sure what Zig version will work, see the `build.zig`
file which has a constant `required_zig`. Ghostty plans to pin to Zig 0.12
once it is released, which will make all of this much easier.
With Zig and necessary dependencies installed, a binary can be built using With Zig and necessary dependencies installed, a binary can be built using
`zig build`: `zig build`: