From 098873809fbc3e0453dfbe59274705dda74bf94e Mon Sep 17 00:00:00 2001 From: Stephan Dilly Date: Wed, 26 Aug 2020 18:37:13 +0200 Subject: [PATCH] fix config paths (closes #243) and reword some docs --- KEY_CONFIG.md | 17 +++++++++-------- THEMES.md | 2 +- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/KEY_CONFIG.md b/KEY_CONFIG.md index d8f1bdc0..3841dc93 100644 --- a/KEY_CONFIG.md +++ b/KEY_CONFIG.md @@ -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. diff --git a/THEMES.md b/THEMES.md index a9a7fa47..872e5663 100644 --- a/THEMES.md +++ b/THEMES.md @@ -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)