Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-07-14 15:56:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Mitchell Hashimoto
2022-07-08 15:59:20 -07:00
parent a4e3f93be0
commit 9e82d682c5
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -18,9 +18,9 @@ modern, opt-in features that enable CLI tool developers to build more feature
rich, interactive applications. rich, interactive applications.
There are a number of excellent terminal emulator options that exist There are a number of excellent terminal emulator options that exist
today. The unique goal of ghostty is to have a platform for experimenting today. The unique goal of ghostty is to have a platform for experimenting
with modern, optional, non-standards-compliant features to enhance the with modern, optional, non-standards-compliant features to enhance the
capabilities of CLI applications. We aim to be the best in this category, capabilities of CLI applications. We aim to be the best in this category,
and competitive in the rest. and competitive in the rest.
While aiming for this ambitious goal, ghostty is a fully standards compliant While aiming for this ambitious goal, ghostty is a fully standards compliant
@ -43,3 +43,32 @@ The high-level ambitious plan for the project, in order:
| 4 | Richer windowing features -- multi-window, tabbing, panes | ❌ | | 4 | Richer windowing features -- multi-window, tabbing, panes | ❌ |
| 5 | Optimal rendering performance | ❌ | | 5 | Optimal rendering performance | ❌ |
| N | Fancy features (to be expanded upon later) | ❌ | | N | Fancy features (to be expanded upon later) | ❌ |
## Developing Ghostty
Ghostty is built using both the [Zig](https://ziglang.org/) programming
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
all the necessary dependencies pinned to exact versions.
With Zig installed, a binary can be built using `zig build`:
```shell-session
$ zig build
...
$ zig-out/bin/ghostty
```
This will build a binary for the currently running system (if supported).
You can cross compile by setting `-Dtarget=<target-triple>`. For example,
`zig build -Dtarget=aarch64-macos` will build for Apple Silicon macOS. Note
that not all targets supported by Zig are supported.
Other useful commands:
* `zig build test` for running unit tests.
* `zig build run -Dconformance=<name>` run a conformance test case from
the `conformance` directory. The `name` is the name of the file. This runs
in the current running terminal emulator so if you want to check the
behavior of this project, you must run this command in ghostty.