Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-08-02 14:57:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

slight edits

Browse Source
This commit is contained in:
Mitchell Hashimoto
2023-11-14 09:21:45 -08:00
parent 42c6381683
commit 648a521fb2
1 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -22,19 +22,26 @@
## About ## About
Ghostty is an innovative terminal emulator with very ambitious goals. Ghostty is a cross-platform, GPU-accelerated terminal emulator that aims to
push the boundaries of what is possible with a terminal emulator by exposing
modern, opt-in features that enable CLI tool developers to build more feature
rich, interactive applications.
- ✅ performance competitive with the fastest GPU-accelerated terminals There are a number of excellent terminal emulator options that exist
- ✅ cross-platform with native UI on macOS and Linux (and Windows is on the roadmap) today. The unique goal of Ghostty is to have a platform for experimenting
- ✅ feature-rich: splits, shell integration, emojis, [Kitty graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol), terminal inspector with modern, optional, non-standards-compliant features to enhance the
- ✅ highly customizable: variable fonts, background blurring, cursor opacity, window themes capabilities of CLI applications. We aim to be the best in this category,
- 🚧 introduce cutting-edge, opt-in terminal capabilities that CLIs can utilize and competitive in the rest.
On the last goal, there are many excellent terminal emulators today, but Ghostty is unique in this. While aiming for this ambitious goal, Ghostty is a fully standards compliant
By exposing new [terminal capabilities](https://en.wikipedia.org/wiki/ANSI_escape_code#CSIsection) that CLIs can terminal emulator that aims to remain compatible with all existing shells
leverage for richer interactivity, Ghostty pushes the boundaries of what is possible with a terminal emulator. and software. You can use this as a drop-in replacement for your existing
terminal emulator.
**Project Status:** Ghostty is still in beta but implements most of the features you'd expect for a daily driver. See more in [Roadmap and Status](#roadmap-and-status). **Project Status:** Ghostty is still in beta but implements most of the
features you'd expect for a daily driver. We currently have hundreds of active
beta users using Ghostty as their primary terminal. See more in
[Roadmap and Status](#roadmap-and-status).
## Download ## Download
@ -93,9 +100,10 @@ palette = 15=#fbf1c7
``` ```
While the set of config keys and values are not yet documented, they are While the set of config keys and values are not yet documented, they are
easily discoverable in the [Config structure](https://github.com/mitchellh/ghostty/blob/main/src/config/Config.zig). discoverable in the [Config structure](https://github.com/mitchellh/ghostty/blob/main/src/config/Config.zig).
The available keys are simply the keys verbatim, and their possible values The available keys are the keys verbatim, and their possible values are typically
are often documented in the comments. You also can search for the [public config files](https://github.com/search?q=path%3Aghostty%2Fconfig&type=code) documented in the comments. You also can search for the
[public config files](https://github.com/search?q=path%3Aghostty%2Fconfig&type=code)
of many Ghostty users for examples and inspiration. of many Ghostty users for examples and inspiration.
#### Configuration Errors #### Configuration Errors
@ -318,14 +326,18 @@ a work-in-progress. Similar improvements will follow with Linux.
## Developing Ghostty ## Developing Ghostty
The official "golden setup" for developing Ghostty is managed by Nix in [shell.nix](https://github.com/mitchellh/ghostty/blob/main/shell.nix). To build Ghostty, you only need [Zig](https://ziglang.org/) installed.
It is the environment in which CI runs tests and builds artifacts. You don't have to use Nix for development, but the
builds produced by your environment mustn't be different from the Nix build; Nix is the source of truth. The official development environment is defined by Nix. You do not need
to use Nix to develop Ghostty, but the Nix environment is the environment
which runs CI tests and builds release artifacts. Any development work on
Ghostty must pass within these Nix environments.
**Note: Zig nightly is required.** Ghostty is built against the nightly **Note: Zig nightly is required.** Ghostty is built against the nightly
releases of Zig while it is still in beta. I plan on stabilizing on a release version when I get releases of Zig while it is still in beta. I plan on stabilizing on a release
closer to generally releasing this to ease downstream packagers. You can find binary releases of nightly builds version when I get closer to generally releasing this to ease downstream
on the [Zig downloads page](https://ziglang.org/download/). packagers. You can find binary releases of nightly builds on the
[Zig downloads page](https://ziglang.org/download/).
With Zig installed, a binary can be built using `zig build`: With Zig installed, a binary can be built using `zig build`: