1
0
Fork 0

add actual README

This commit is contained in:
Andrey Orst 2018-09-22 14:15:53 +03:00
parent cf639b6166
commit 44f40786a7

View file

@ -1,2 +1,40 @@
# fzf.kak
Kakoune plugin 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.
## Installation
Assuming you're using [plug.kak](https://github.com/andreyorst/plug.kak) plugin
manager, add this to your `.kakrc`:
```kak
plug andreyorst/fzf.kak
```
Reload Kakoune and run `:plug-install`. Next time you launch Kakoune plugin will
be loaded automatically.
## Usage
This plugin brings new command: `:fzf-mode` that is better should be mapped to
some mapping. **fzf.kak** doesn't provide any mapping by default so user may
configure it along with user's preference. For example:
```kak
map global normal <c-p> ':fzf-mode<ret>'
```
In this mode new mappings are available:
- <kbd>f</kbd> - Search for file and open it
- <kbd>b</kbd> - Select buffer
- <kbd>t</kbd> - Browse ctags tags
- <kbd>g</kbd> - Edit file in Git tree
So for example pressing <kbd>Ctrl+p</kbd><kbd>f</kbd> will open fzf at the
bottom of the Kakoune buffer, showing you all possible files.
[Kakoune]: http://kakoune.org
[IRC]: https://webchat.freenode.net?channels=kakoune
[IRC Badge]: https://img.shields.io/badge/IRC-%23kakoune-blue.svg