Luj/eat-emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* README.org: Add shell integration instructions

Browse source
This commit is contained in:
Akib Azmain Turja 2022-12-07 00:29:20 +06:00
parent 8188f71562
commit 693940c733
No known key found for this signature in database
GPG key ID: 5535FCF54D88616B
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.org
View file

@ -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.