gitui/KEY_CONFIG.md

# Key Config

The default keys are based on arrow keys to navigate.

However popular demand lead to fully customizability of the key bindings.

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. Use it to copy the content into `key_config.ron` to get vim style key bindings.
Customize key binds (#234) * customizable key config * provide example vim key config * automatically show correct key binding in bottom cmd-bar 2020-08-26 19:23:53 +03:00			`# Key Config`

fix config paths (closes #243) and reword some docs 2020-08-26 19:37:13 +03:00			`The default keys are based on arrow keys to navigate.`
Customize key binds (#234) * customizable key config * provide example vim key config * automatically show correct key binding in bottom cmd-bar 2020-08-26 19:23:53 +03:00
fix config paths (closes #243) and reword some docs 2020-08-26 19:37:13 +03:00			`However popular demand lead to fully customizability of the key bindings.`
Customize key binds (#234) * customizable key config * provide example vim key config * automatically show correct key binding in bottom cmd-bar 2020-08-26 19:23:53 +03:00
fix config paths (closes #243) and reword some docs 2020-08-26 19:37:13 +03:00			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)
Customize key binds (#234) * customizable key config * provide example vim key config * automatically show correct key binding in bottom cmd-bar 2020-08-26 19:23:53 +03:00			* `$XDG_CONFIG_HOME/gitui/key_config.ron` (linux using XDG)
			* `$HOME/.config/gitui/key_config.ron` (linux)

fix config paths (closes #243) and reword some docs 2020-08-26 19:37:13 +03:00			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.