diff --git a/README.org b/README.org index ffc3196..1c4d596 100644 --- a/README.org +++ b/README.org @@ -15,6 +15,8 @@ have, for example complete mouse support. It flickers less than other Emacs terminal emulator, so you get more performance and a smooth experience. +To get the most out of Eat, you should also setup shell integration. + * Usage To start Eat, run =M-x eat=. Eat has three keybinding modes: @@ -62,6 +64,14 @@ following: (add-hook 'eshell-first-time-mode-hook #'eat-eshell-mode) #+end_src +To setup shell integration for GNU Bash, put the following at the end +of your ~.bashrc~: + +#+begin_src sh +[ -n "$EAT_SHELL_INTEGRATION_DIR" ] && \ + source "$EAT_SHELL_INTEGRATION_DIR/bash" +#+end_src sh + * Installation Eat requires at least Emacs 28.1 or above.