Skip to content

Commit

Permalink
docs(readme): image previews info
Browse files Browse the repository at this point in the history
  • Loading branch information
Rolv-Apneseth committed Apr 23, 2024
1 parent 96a4df8 commit fb0de2c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ With this plugin, you can simply change which TFM you wish to use (from the supp

I am using this plugin full time but I don't use all the different file managers and modes available so if you find any issues please let me know and I'll do my best to address it.

## Optional Dependencies

- [ueberzugpp](https://github.com/jstkdng/ueberzugpp): for previewing images. Requires that your chosen file manager supports it.

## Configuration

The setup function is completely optional. However, please note that by default this plugin does not set any keymaps or create any commands, so it is recommended to do so in your configuration.
Expand Down Expand Up @@ -166,6 +162,12 @@ Enum to configure modes with which to open/edit selected files.

## Extras

### Image previews

Image previews depend entirely on the terminal emulator + TFM combo you are using, as well as Neovim's support for the protocol being used. Any issues related to image previews are probably not related to this plugin as all this is doing is opening a terminal window in Neovim and running the TFM.

In the demo video, the combo being used is [Wezterm](https://github.com/wez/wezterm) + [Yazi](https://github.com/sxyazi/yazi), using [ueberzugpp](https://github.com/jstkdng/ueberzugpp).

### Pure Lua keybindings

If you don't want to enable the commands, you can just use pure Lua keybindings:
Expand Down

0 comments on commit fb0de2c

Please sign in to comment.