Elgato_dark/gitui
1
0
Fork 0
mirror of https://github.com/gitui-org/gitui synced 2026-05-22 16:38:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix config paths (closes #243) and reword some docs

Browse source
This commit is contained in:
Stephan Dilly 2020-08-26 18:37:13 +02:00
parent 55e83a58b9
commit 098873809f
2 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
KEY_CONFIG.md
View file

@ -1,15 +1,16 @@
# Key Config
Default using arrow key to navigate the gitui and Ctrl + C to quit the program
The default keys are based on arrow keys to navigate.
The first time Gitui will create `key_config.ron` file automatically.
You can change the every single key bindings of the program as what you like.
However popular demand lead to fully customizability of the key bindings.
The config file format is [Ron format](https://github.com/ron-rs/ron).
And the path differs depending on the operating system:
* `$HOME/Library/Preferences/gitui/key_config.ron` (mac)
On first start `gitui` will create `key_config.ron` file automatically based on the defaults.
This file allows changing every key binding.
The config file format based on the [Ron file format](https://github.com/ron-rs/ron).
The location of the file depends on your OS:
* `$HOME/Library/Application Support/gitui/key_config.ron` (mac)
* `$XDG_CONFIG_HOME/gitui/key_config.ron` (linux using XDG)
* `$HOME/.config/gitui/key_config.ron` (linux)
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.
You can use it to replace `key_config.ron` and get a vim style setting.
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.

2
THEMES.md
View file

@ -6,7 +6,7 @@ default on light terminal:
to change the colors of the program you have to modify `theme.ron` file
[Ron format](https://github.com/ron-rs/ron) located at config path. The path differs depending on the operating system:
* `$HOME/Library/Preferences/gitui/theme.ron` (mac)
* `$HOME/Library/Application Support/gitui/theme.ron` (mac)
* `$XDG_CONFIG_HOME/gitui/theme.ron` (linux using XDG)
* `$HOME/.config/gitui/theme.ron` (linux)