Skip to content

Commit 0988738

Browse files
author
Stephan Dilly
committed
fix config paths (closes #243) and reword some docs
1 parent 55e83a5 commit 0988738

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

KEY_CONFIG.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Key Config
22

3-
Default using arrow key to navigate the gitui and Ctrl + C to quit the program
3+
The default keys are based on arrow keys to navigate.
44

5-
The first time Gitui will create `key_config.ron` file automatically.
6-
You can change the every single key bindings of the program as what you like.
5+
However popular demand lead to fully customizability of the key bindings.
76

8-
The config file format is [Ron format](https://github.com/ron-rs/ron).
9-
And the path differs depending on the operating system:
10-
* `$HOME/Library/Preferences/gitui/key_config.ron` (mac)
7+
On first start `gitui` will create `key_config.ron` file automatically based on the defaults.
8+
This file allows changing every key binding.
9+
10+
The config file format based on the [Ron file format](https://github.com/ron-rs/ron).
11+
The location of the file depends on your OS:
12+
* `$HOME/Library/Application Support/gitui/key_config.ron` (mac)
1113
* `$XDG_CONFIG_HOME/gitui/key_config.ron` (linux using XDG)
1214
* `$HOME/.config/gitui/key_config.ron` (linux)
1315

14-
Here is a [vim style key config](assets/vim_style_key_config.ron) with `h`, `j`, `k`, `l` to navigate and `Ctrl + C` to leave.
15-
You can use it to replace `key_config.ron` and get a vim style setting.
16+
Here is a [vim style key config](assets/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.

THEMES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ default on light terminal:
66
to change the colors of the program you have to modify `theme.ron` file
77
[Ron format](https://github.com/ron-rs/ron) located at config path. The path differs depending on the operating system:
88

9-
* `$HOME/Library/Preferences/gitui/theme.ron` (mac)
9+
* `$HOME/Library/Application Support/gitui/theme.ron` (mac)
1010
* `$XDG_CONFIG_HOME/gitui/theme.ron` (linux using XDG)
1111
* `$HOME/.config/gitui/theme.ron` (linux)
1212

0 commit comments

Comments
 (0)