From 0dd2838dcfc5aca67b343938a506347e1c106659 Mon Sep 17 00:00:00 2001 From: Andrey Orst Date: Sat, 24 Nov 2018 15:35:10 +0300 Subject: [PATCH] Updated readme --- README.md | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0b8b165..48f5892 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,11 @@ ![Github commits (since latest release)](https://img.shields.io/github/commits-since/andreyorst/fzf.kak/latest.svg) ![license](https://img.shields.io/github/license/andreyorst/fzf.kak.svg) -> **fzf.kak** is a plugin for [Kakoune](https://github.com/mawww/kakoune) editor, that brings integration with [fzf](https://github.com/junegunn/fzf) -> tool. This plugin is being tested against Kakoune 2018.09.04. +**fzf.kak** is a plugin for [Kakoune](https://github.com/mawww/kakoune) editor, that brings integration with [fzf](https://github.com/junegunn/fzf) +tool. This plugin is being tested against Kakoune 2018.09.04. ![showcase](https://user-images.githubusercontent.com/19470159/46813471-6ee76800-cd7f-11e8-89aa-123b3a5f9f1b.gif) -### Dependencies -|Tool |Information | -|:--------:|:--------------------------------------------------------------------------------------| -|tmux |Depends on [fzf-tmux](https://github.com/junegunn/fzf/blob/master/bin/fzf-tmux) script.| -|X11 |X11 supported via `termcmd` option. | -|GNU Screen|GNU Screen is not yet supported. | -|ctags |[universal-ctags](https://github.com/universal-ctags/ctags) package. | - ## 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`: @@ -39,16 +31,14 @@ map global normal ': fzf-mode' ``` Each fzf subcommand has mnemonic mapping, like `f` for opening files, `t` for tags and so on. Available mappings: -- b - Select buffer -- c - Switch servers working directory -- f - Search for file and open it -- v - Edit file in version control system tree -- - Explicitly select which vcs command to run -- s - Search over buffer contents and jump to result line -- t - Browse ctags tags - fzf.kak supports filtering tags on per language basis. For each filetype - press alt+filter key specified in the info box to - reload fzf buffer with the desired filter. +- b - Select buffer +- c - Switch servers working directory +- f - Search for file and open it +- v - Edit file in version control system tree +- Alt+v - Explicitly select which vcs command to run +- s - Search over buffer contents and jump to result line +- t - Browse ctags tags +- Alt+t - Select tag kind filter on per language basis So for example pressing Ctrl+pf will open fzf at the bottom of the Kakoune buffer, showing you all possible files.