From 77b038dcb6c239a2885ebcaeeec9042ad1eb47e3 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Thu, 30 Oct 2025 13:14:02 -0700 Subject: [PATCH] update README --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7124400fd..961968097 100644 --- a/README.md +++ b/README.md @@ -144,16 +144,23 @@ In addition to being a standalone terminal emulator, Ghostty is a C-compatible library for embedding a fast, feature-rich terminal emulator in any 3rd party project. This library is called `libghostty`. -This goal is not hypothetical! The macOS app is a `libghostty` consumer. +Due to the scope of this project, we're breaking libghostty down into +separate actually libraries, starting with `libghostty-vt`. The goal of +this project is to focus on parsing terminal sequences and maintaining +terminal state. This is covered in more detail in this +[blog post](https://mitchellh.com/writing/libghostty-is-coming). + +`libghostty-vt` is already available and usable today for Zig and C and +is compatible for macOS, Linux, Windows, and WebAssembly. At the time of +writing this, the API isn't stable yet and we haven't tagged an official +release, but the core logic is well proven (since Ghostty uses it) and +we're working hard on it now. + +The ultimate goal is not hypothetical! The macOS app is a `libghostty` consumer. The macOS app is a native Swift app developed in Xcode and `main()` is within Swift. The Swift app links to `libghostty` and uses the C API to render terminals. -This step encompasses expanding `libghostty` support to more platforms -and more use cases. At the time of writing this, `libghostty` is very -Mac-centric -- particularly around rendering -- and we have work to do to -expand this to other platforms. - ## Crash Reports Ghostty has a built-in crash reporter that will generate and save crash