docs: add a note about terminal key bindings

This commit is contained in:
CJ van den Berg 2024-02-29 18:30:27 +01:00
parent d51895248d
commit ed22cbeba5
2 changed files with 28 additions and 0 deletions

View file

@ -27,6 +27,19 @@ Place it in your path for convenient access.
See --help for full command line.
# Terminal configuration
Kitty, Ghostty and most other terminals have default keybindings that conflict
with common editor commands. I highly recommend rebinding them to keys that are
not generally used anywhere else.
For Kitty rebinding `kitty_mod` is usually enough:
```
kitty_mod ctrl+alt
```
For Ghostty each conflicting binding has to be reconfigured individually.
# Requirements
- A modern terminal with 24bit color and kitty keyboard protocol support (kitty and ghostty are the only recommended terminals at this time)
- NerdFonts support

15
help.md
View file

@ -1,5 +1,20 @@
# Flow Control: a programmer's text editor
## Terminal configuration
Most terminals have default keybindings that conflict with common editor
commands. I highly recommend rebinding them to keys that are not generally
used anywhere else.
For Kitty rebinding `kitty_mod` by adding this line to your kitty.conf is
usually enough:
```
kitty_mod ctrl+alt
```
For other editors you will probably have to disable or rebind them each
individually.
## Searching
Press Ctrl-f to search this help file. Type a search term and press