update README

This commit is contained in:
Mitchell Hashimoto
2022-07-14 14:22:31 -07:00
parent 60a48bc36a
commit 7ac2c591d2

View File

@ -67,6 +67,10 @@ language as well as the Zig build system. At a minimum, Zig must be installed.
For [Nix](https://nixos.org/) users, a `shell.nix` is available which includes For [Nix](https://nixos.org/) users, a `shell.nix` is available which includes
all the necessary dependencies pinned to exact versions. all the necessary dependencies pinned to exact versions.
**Note: Zig nightly is required.** Ghostty is built against the nightly
releases of Zig. The latest released version (0.9.1 at the time of this
edit) will NOT work.
With Zig installed, a binary can be built using `zig build`: With Zig installed, a binary can be built using `zig build`:
```shell-session ```shell-session
@ -81,10 +85,6 @@ You can cross compile by setting `-Dtarget=<target-triple>`. For example,
`zig build -Dtarget=aarch64-macos` will build for Apple Silicon macOS. Note `zig build -Dtarget=aarch64-macos` will build for Apple Silicon macOS. Note
that not all targets supported by Zig are supported. that not all targets supported by Zig are supported.
**Note: Zig nightly is required.** Ghostty is built against the nightly
releases of Zig. The latest released version (0.9.1 at the time of this
edit) will NOT work.
Other useful commands: Other useful commands:
* `zig build test` for running unit tests. * `zig build test` for running unit tests.