diff options
| author | Kyohei Uto <kyoheiu@outlook.com> | 2022-08-15 05:17:11 +0900 |
|---|---|---|
| committer | Kyohei Uto <kyoheiu@outlook.com> | 2022-08-15 05:17:11 +0900 |
| commit | f5501e03001e87e2a48b73e38e06b552c9c5a665 (patch) | |
| tree | c87908bf55e2edda07c26715db70290d37c69cdb /README.md | |
| parent | 8b7f6d504e2b6497a7ea4bad5af4acc41f35d9b7 (diff) | |
Fix README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 22 insertions, 12 deletions
@@ -68,6 +68,15 @@ cd felix cargo install --path . ``` +## Integrations + +In addition, you can use felix more conveniently by installing these two apps: + +- [zoxide](https://github.com/ajeetdsouza/zoxide): A smarter `cd` command, which enables you to jump to a directory that matches the keyword in felix. +- [chafa](https://hpjansson.org/chafa/): Terminal graphics for the 21st century, by which you can preview images in felix. + +These apps do not need any configuration to use with felix! + ## Usage ``` @@ -95,7 +104,7 @@ o :Open a fila in a new window. gg :Go to the top. G :Go to the bottom. z + Enter :Go to the home directory. -z <keyword> :Jump to a directory that matches the keyword. (zoxide* required) +z <keyword> :Jump to a directory that matches the keyword. (zoxide required) dd :Delete and yank one item. yy :Yank one item. p :Put yanked item(s) in the current directory. @@ -119,26 +128,27 @@ Esc :Return to the normal mode. :q / ZZ :Exit. ``` -\* zoxide https://github.com/ajeetdsouza/zoxide - ## Preview feature -By default, text files and directories can be previewed. -To preview images, you need to install chafa. -Please see https://hpjansson.org/chafa/. +By default, text files and directories can be previewed. +Install `chafa` and you can preview images without any configuration. ## Configuration ### Linux -config file : $XDG_CONFIG_HOME/felix/config.toml -trash directory: $XDG_CONFIG_HOME/felix/trash -log files : \$XDG_CONFIG_HOME/felix/log +``` +config file : $XDG_CONFIG_HOME/felix/config.toml +trash directory : $XDG_CONFIG_HOME/felix/trash +log files : \$XDG_CONFIG_HOME/felix/log +``` ### macOS -config file : $HOME/Library/Application Support/felix/config.toml -trash directory: $HOME/Library/Application Support/felix/trash -log files : \$HOME/Library/Application Support/felix/log +``` +config file : $HOME/Library/Application Support/felix/config.toml +trash directory : $HOME/Library/Application Support/felix/trash +log files : \$HOME/Library/Application Support/felix/log +``` For more details, visit https://kyoheiu.dev/felix. |