Skip to content

Commit 420ba48

Browse files
authored
Merge pull request #361 from pluiedev/pluie/jj-yrsxxrtwlkqy
docs/install: point users to HACKING.md, correct typos
2 parents aa2662b + 1c9aa06 commit 420ba48

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/install/build.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,20 @@ If you have access to a prebuilt binary or package, you should use that
1313
instead. See [the binaries and packages page](/docs/install/binary) to
1414
see if a prebuilt binary or package is available for your platform.
1515

16+
If you intend to develop or package Ghostty, please also check out our
17+
["Developing Ghostty"](https://github.com/ghostty-org/ghostty/blob/main/HACKING.md)
18+
and ["Packaging Ghostty"](https://github.com/ghostty-org/ghostty/blob/main/PACKAGING.md)
19+
documents respectively. This page is more oriented towards end users who
20+
want or need to build Ghostty from source for personal use.
21+
1622
</Tip>
1723

18-
To build Ghostty, you need [Zig](https://ziglang.org/) installed.
24+
To build Ghostty, you need to first install [Zig](https://ziglang.org/).
1925

2026
<Important>
2127

2228
Each version of Ghostty is only guaranteed to build for one **specific** version
23-
of Zig as it is still a rapidly-evolving project. **Either older or newer
29+
of Zig as it is still a rapidly-evolving language. **Either older or newer
2430
Zig compilers may not be able to build Ghostty.** If your package manager
2531
maintains a different version of Zig than what Ghostty requires, you can use
2632
static binary releases of the Zig compiler on the [Zig downloads page](https://ziglang.org/download/).
@@ -58,8 +64,8 @@ This is because source tarballs contain various preprocessed files that make
5864
Ghostty require far fewer dependencies to compile.
5965

6066
If you intend to contribute to Ghostty, please consult the
61-
[README](https://github.com/ghostty-org/ghostty/blob/main/README.md#developing-ghostty)
62-
file on the steps to build Ghostty in a development environment.
67+
["Developing Ghostty"](https://github.com/ghostty-org/ghostty/blob/main/HACKING.md)
68+
documents on how to build Ghostty in a development environment.
6369
While most of the steps are exactly the same, we will be assuming a source
6470
tarball-based build for now on for the sake of simplicity.
6571

@@ -149,9 +155,7 @@ Required dependencies:
149155

150156
<Important>
151157

152-
If you're using a Git checkout, you also need to install these dependnecies:
153-
154-
* `blueprint-compiler`
158+
If you're using a Git checkout, you also need to install these dependencies:
155159

156160
</Important>
157161

0 commit comments

Comments
 (0)