From 690e88dd1a0ba58d34b1c0db0cfae7577d385df8 Mon Sep 17 00:00:00 2001 From: Bertrand Chardon <51328958+bertrand-chardon@users.noreply.github.com> Date: Tue, 31 Dec 2024 13:53:46 +0100 Subject: [PATCH] docs: move parts of README to Wiki (#199) the sections for _keybindings_, the _configuration file_ and _search patterns_ are now located in dedicated pages of the Wiki and referred to in the README --- README.md | 41 +++-------------------------------------- 1 file changed, 3 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index ff745df..b8dba13 100644 --- a/README.md +++ b/README.md @@ -78,37 +78,13 @@ https://github.com/user-attachments/assets/395f17f6-14b9-4015-a50a-648259d9f253 ## Keybindings -Default keybindings are as follows: -| Key | Description | -| :---: | ----------- | -| / or Ctrl + p / n or Ctrl + k / j | Navigate through the list of entries | -| Ctrl + u / d | Scroll the preview pane up / down | -| Enter | Select the current entry | -| Ctrl + y | Copy the selected entry to the clipboard | -| Ctrl + r | Toggle remote control mode | -| Ctrl + s | Toggle send to channel mode | -| Ctrl + g | Toggle the help panel | -| Ctrl + o | Toggle the preview panel | -| Esc | Quit the application | - -These keybindings are all configurable (see [Configuration](#configuration)). +For information about available keybindings, check the [associated page of the wiki](https://github.com/alexpasmantier/television/wiki/Keybindings) ## Configuration -**Default configuration: [config.toml](./.config/config.toml)** - -Locations where `television` expects the configuration files to be located for each platform: - -|Platform|Value| -|--------|:-----:| -|Linux|`$HOME/.config/television/config.toml`| -|macOS|`$HOME/.config/television/config.toml`| -|Windows|`{FOLDERID_LocalAppData}\television\config`| - -Or, if you'd rather use the XDG Base Directory Specification, tv will look for the configuration file in -`$XDG_CONFIG_HOME/television/config.toml` if the environment variable is set. +For information about tv's configuration file, check the [associated page of the wiki](https://github.com/alexpasmantier/television/wiki/Configuration-file) ## Themes Builtin themes are available in the [themes](./themes) directory. Feel free to experiment and maybe even contribute your own! @@ -126,18 +102,7 @@ config_location/ ``` ## Search Patterns -`television` uses a fuzzy matching algorithm to filter the list of entries. Its behavior depends on the input pattern you provide. - -| Matcher | Pattern | -| --- | :---: | -| Fuzzy | `foo` | -| Substring | `'foo` / `!foo` to negate | -| Prefix | `^foo` / `!^foo` to negate | -| Suffix | `foo$` / `!foo$` to negate | -| Exact | `^foo$` / `!^foo$` to negate | - -For more information on the matcher behavior, see the -[nucleo-matcher](https://docs.rs/nucleo-matcher/latest/nucleo_matcher/pattern/enum.AtomKind.html) documentation. +For information on how to use search patterns with tv, refer to the [associated page of the wiki](https://github.com/alexpasmantier/television/wiki/Search-patterns) ## Contributions