From dead82bcf13f49b77d51f01b719f27c3a27fd178 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Wed, 22 Nov 2023 22:25:47 -0800 Subject: [PATCH] update README to cover themes --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index f029d80c2..52a38553e 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,33 @@ if something isn't working. Eventually, we'll have a better mechanism for showing errors to the user. +### Themes + +Ghostty ships with 300+ built-in themes (from +[iTerm2 Color Schemes](https://github.com/mbadolato/iTerm2-Color-Schemes)). +You can configure Ghostty to use any of these themes using the `theme` +configuration. Example: + +``` +theme = Solarized Dark - Patched +``` + +You can find a list of built-in themes using the `+list-themes` action: + +``` +$ ghostty +list-themes +... +``` + +On macOS, the themes are built-in to the `Ghostty.app` bundle. On Linux, +theme support requires a valid Ghostty resources dir ("share" directory). +More details about how to validate the resources directory on Linux +is covered in the [shell integration section](#shell-integration-installation-and-verification). + +Any custom color configuration (`palette`, `background`, `foreground`, etc.) +in your configuration files will override the theme settings. This can be +used to load a theme and fine-tune specific colors to your liking. + ### Shell Integration Ghostty supports some features that require shell integration. I am aiming