From 881324b10bd1c407c9f916926e5e0f33b1ec79af Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Mon, 24 Jun 2024 18:18:17 -0400 Subject: [PATCH 1/2] Clarify shell integration installation --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 28772dd2c..6f6ad15cf 100644 --- a/README.md +++ b/README.md @@ -257,14 +257,21 @@ is launched within Ghostty and (2) to find the shell-integration. For example, for bash, you'd put this _at the top_ of your `~/.bashrc`: ```bash -# Ghostty shell integration -if [ -n "$GHOSTTY_RESOURCES_DIR" ]; then +# Ghostty shell integration for Bash. This must be at the top of your +# bashrc! +if [ -n "${GHOSTTY_RESOURCES_DIR}" ]; then builtin source "${GHOSTTY_RESOURCES_DIR}/shell-integration/bash/ghostty.bash" fi ``` -**This must be at the top of your bashrc, not the bottom.** The same -goes for any other shell. +Each shell integration's installation instructions are documented inline: + +| Shell | Integration +| ------ | ----------- +| `bash` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/bash/ghostty.bash` +| `fish` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/fish/vendor_conf.d/ghostty-shell-integration.fish` +| `zsh` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/zsh/ghostty-integration` + ### Terminfo From 2246da7207da925d44460952bf90d7cce3fcac75 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Mon, 24 Jun 2024 16:01:02 -0700 Subject: [PATCH 2/2] prettier --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f6ad15cf..43d3a3d19 100644 --- a/README.md +++ b/README.md @@ -257,8 +257,7 @@ is launched within Ghostty and (2) to find the shell-integration. For example, for bash, you'd put this _at the top_ of your `~/.bashrc`: ```bash -# Ghostty shell integration for Bash. This must be at the top of your -# bashrc! +# Ghostty shell integration for Bash. This must be at the top of your bashrc! if [ -n "${GHOSTTY_RESOURCES_DIR}" ]; then builtin source "${GHOSTTY_RESOURCES_DIR}/shell-integration/bash/ghostty.bash" fi @@ -266,12 +265,11 @@ fi Each shell integration's installation instructions are documented inline: -| Shell | Integration -| ------ | ----------- -| `bash` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/bash/ghostty.bash` -| `fish` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/fish/vendor_conf.d/ghostty-shell-integration.fish` -| `zsh` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/zsh/ghostty-integration` - +| Shell | Integration | +| ------ | ---------------------------------------------------------------------------------------------- | +| `bash` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/bash/ghostty.bash` | +| `fish` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/fish/vendor_conf.d/ghostty-shell-integration.fish` | +| `zsh` | `${GHOSTTY_RESOURCES_DIR}/shell-integration/zsh/ghostty-integration` | ### Terminfo