diff options
author | Junegunn Choi <junegunn.c@gmail.com> | 2016-09-13 04:11:28 +0900 |
---|---|---|
committer | Junegunn Choi <junegunn.c@gmail.com> | 2016-09-13 04:12:03 +0900 |
commit | 8ef2420677abf5cca27b47bead6e70e42220c7aa (patch) | |
tree | 861649a7b2e46e20a918c52d912a2e315d30b2da /README.md | |
parent | cf6f4d74c4bf7fcbc7807a89f50974da719ae2b0 (diff) |
Update README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 22 insertions, 15 deletions
@@ -10,18 +10,15 @@ Pros - No dependencies - Blazingly fast - - e.g. `locate / | fzf` -- Flexible layout - - Runs in fullscreen or in horizontal/vertical split using tmux - The most comprehensive feature set - - Try `fzf --help` and be surprised +- Flexible layout using tmux panes - Batteries included - Vim/Neovim plugin, key bindings and fuzzy auto-completion Installation ------------ -fzf project consists of the following: +fzf project consists of the following components: - `fzf` executable - `fzf-tmux` script for launching fzf in a tmux pane @@ -30,12 +27,12 @@ fzf project consists of the following: - Fuzzy auto-completion (bash, zsh) - Vim/Neovim plugin -You can [download fzf executable][bin] alone, but it's recommended that you -install the extra stuff using the attached install script. +You can [download fzf executable][bin] alone if you don't need the extra +stuff. [bin]: https://github.com/junegunn/fzf-bin/releases -#### Using git (recommended) +### Using git Clone this repository and run [install](https://github.com/junegunn/fzf/blob/master/install) script. @@ -45,7 +42,7 @@ git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf ~/.fzf/install ``` -#### Using Homebrew +### Using Homebrew On OS X, you can use [Homebrew](http://brew.sh/) to install fzf. @@ -56,26 +53,30 @@ brew install fzf /usr/local/opt/fzf/install ``` -#### Install as Vim plugin +### Vim plugin -Once you have cloned the repository, add the following line to your .vimrc. +You can manually add the directory to `&runtimepath` as follows, ```vim +" If installed using git set rtp+=~/.fzf + +" If installed using Homebrew +set rtp+=/usr/local/opt/fzf ``` -Or you can have [vim-plug](https://github.com/junegunn/vim-plug) manage fzf -(recommended): +But it's recommended that you use a plugin manager like +[vim-plug](https://github.com/junegunn/vim-plug). ```vim Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' } ``` -#### Upgrading fzf +### Upgrading fzf fzf is being actively developed and you might want to upgrade it once in a while. Please follow the instruction below depending on the installation -method. +method used. - git: `cd ~/.fzf && git pull && ./install` - brew: `brew update; brew reinstall fzf` @@ -390,6 +391,12 @@ fzf export FZF_CTRL_T_COMMAND="$FZF_DEFAULT_COMMAND" ``` +If you don't want to exclude hidden files, use the following command: + +```sh +export FZF_DEFAULT_COMMAND='ag --hidden --ignore .git -g ""' +``` + #### `git ls-tree` for fast traversal If you're running fzf in a large git repository, `git ls-tree` can boost up the |