From 50a24b7503ec39e8c8156f7eb2318beca2fc8f7b Mon Sep 17 00:00:00 2001 From: quak Date: Sat, 1 Feb 2025 23:05:47 +0100 Subject: [PATCH] updated the readme file --- README.md | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e3b156c..a26eec6 100644 --- a/README.md +++ b/README.md @@ -30,28 +30,9 @@ Every shell has its own stack, save in the file `/tmp/navigate/`. The behaviour of `navigate` can be configured in the file `$XDG_CONFIG_HOME/navigate/navigate.toml`. *It has the toml extension, but might not implement the full toml specification.* -At the time of writing, the following options are recognised: -* `general` - * `show_stack_on_push`: bool = false - * `show_stack_on_pop`: bool = false - * `show_books_on_bookmark`: bool = false -* `format` - * `align_separators`: bool = true - * `stack_separator`: string = " - " - * `stack_home_as_tilde`: bool = false - * `bookmarks_separator`: string = " - " - * `book_home_as_tilde`: bool = false -* `styles` - * `warning_style`: string = "yellow, italic" - * `error_style`: string = "red, bold" - * `stack_number_style`: string = "default" - * `stack_separator_style`: string = "cyan" - * `stack_path_style`: string = "default" - * `stack_punct_style`: string = "magenta" - * `bookmarks_name_style`: string = "default" - * `bookmarks_separator_style`: string = "cyan" - * `bookmarks_path_style`: string = "default" - * `bookmarks_punct_style`: string = "magenta" +> `navigate` will check for the file `default.toml` in the configuration directory and create it if not found. +> It contains all settings with default values and a short explanation. +> After an update one can delete the file and call any subcommand of `navigate` to get an updated default configuration. The lines without type and value are categories and need to be defined as toml table (`[table]`) in the configuration file. Options are written as `value = key`. @@ -61,7 +42,5 @@ Style settings accept styles and one color in the following formats: * **numbered color**: `16`..`255` * **rgb color**: `#rrggbb` -***NOTE**: The styles and colors are applied as ansi escape sequences and most terminals do not support all options.* - -See [navigate.toml](./navigate.toml) for an example configuration file. +> *NOTE*: The styles and colors are applied as ansi escape sequences and I do not know a terminal which implements all sequences.