Skip to content

Commit 95b2737

Browse files
author
Stephan Dilly
committed
document new symbol overwrite feature
1 parent 3db1a68 commit 95b2737

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

KEY_CONFIG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,19 @@ The location of the file depends on your OS:
1515
* `%APPDATA%/gitui/key_config.ron` (Windows)
1616

1717
Here is a [vim style key config](vim_style_key_config.ron) with `h`, `j`, `k`, `l` to navigate. Use it to copy the content into `key_config.ron` to get vim style key bindings.
18+
19+
# Key Symbols
20+
21+
Similar to the above GitUI allows you to change the way the UI visualizes key combos containing special keys like `enter`(default: ``) and `shift`(default: ``).
22+
23+
If we can find a file `key_symbols.ron` in the above folders we apply the overwrites in it.
24+
25+
Example content of this file looks like:
26+
27+
```
28+
(
29+
enter: Some("enter"),
30+
shift: Some("shift-")
31+
)
32+
```
33+
This example will only overwrite two symbols. Find all possible symbols to overwrite in `symbols.rs` in the type `KeySymbolsFile` ([src/keys/symbols.rs](https://github.com/extrawurst/gitui/blob/master/src/keys/symbols.rs))

0 commit comments

Comments
 (0)