add note about X11 support to readme
This commit is contained in:
parent
9f8472d8ac
commit
e88a9159aa
1 changed files with 19 additions and 5 deletions
24
README.md
24
README.md
|
@ -3,17 +3,31 @@
|
||||||
**fzf.kak** is a plugin for Kakoune editor, that brings integration with fzf
|
**fzf.kak** is a plugin for Kakoune editor, that brings integration with fzf
|
||||||
tool. This plugin is being tested against Kakoune 2018.09.04.
|
tool. This plugin is being tested against Kakoune 2018.09.04.
|
||||||
|
|
||||||
## Installation
|
### Dependencies
|
||||||
This plugin requires Tmux. Support for X11 is planned in the near future.
|
|
||||||
|
|
||||||
Assuming you're using [plug.kak](https://github.com/andreyorst/plug.kak) plugin
|
#### tmux
|
||||||
manager, add this to your `.kakrc`:
|
If you're using tmux make sure, that fzf-tmux script is installed and available.
|
||||||
|
|
||||||
|
#### X11
|
||||||
|
Script works with X11 via `termcmd` option, but needs more testing, so think of
|
||||||
|
it as experimental feature for now.
|
||||||
|
|
||||||
|
#### GNU Screen
|
||||||
|
|
||||||
|
GNU Screen is not yet supported.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Recommended way to install is to use [plug.kak](https://github.com/andreyorst/plug.kak) plugin
|
||||||
|
manager. You can install **fzf.kak** by adding this to your `kakrc`:
|
||||||
|
|
||||||
```kak
|
```kak
|
||||||
plug andreyorst/fzf.kak
|
plug andreyorst/fzf.kak
|
||||||
```
|
```
|
||||||
|
|
||||||
Reload Kakoune config by and run `:plug-install`. Or install this plugin any other preferred way.
|
Then reload Kakoune config or restart Kakoune and run `:plug-install`.
|
||||||
|
|
||||||
|
Or install this plugin any other preferred way.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue