diff options
author | Junegunn Choi <junegunn.c@gmail.com> | 2017-11-22 02:58:54 +0900 |
---|---|---|
committer | Junegunn Choi <junegunn.c@gmail.com> | 2017-11-22 03:10:20 +0900 |
commit | 6b27554cdb4742b3776dc1a7a4b7590c640e7779 (patch) | |
tree | 8b51bab48bb4234f67657d711f79cf6bc30b3dc3 /README.md | |
parent | fc1b119159f24136e64a85a8ea3dd51f19161602 (diff) |
Clarify installation instructions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 50 |
1 files changed, 33 insertions, 17 deletions
@@ -23,8 +23,8 @@ Table of Contents ----------------- * [Installation](#installation) - * [Using git](#using-git) * [Using Homebrew or Linuxbrew](#using-homebrew-or-linuxbrew) + * [Using git](#using-git) * [As Vim plugin](#as-vim-plugin) * [Fedora](#fedora) * [Windows](#windows) @@ -74,20 +74,10 @@ stuff. [bin]: https://github.com/junegunn/fzf-bin/releases -### Using git - -Clone this repository and run -[install](https://github.com/junegunn/fzf/blob/master/install) script. - -```sh -git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf -~/.fzf/install -``` - ### Using Homebrew or Linuxbrew -Alternatively, you can use [Homebrew](http://brew.sh/) or -[Linuxbrew](http://linuxbrew.sh/) to install fzf. +You can use [Homebrew](http://brew.sh/) or [Linuxbrew](http://linuxbrew.sh/) +to install fzf. ```sh brew install fzf @@ -96,23 +86,49 @@ brew install fzf $(brew --prefix)/opt/fzf/install ``` +### Using git + +Alternatively, you can "git clone" this repository to any directory and run +[install](https://github.com/junegunn/fzf/blob/master/install) script. + +```sh +git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf +~/.fzf/install +``` + ### As Vim plugin -You can manually add the directory to `&runtimepath` as follows, +Once you have fzf installed, you can enable it inside Vim simply by adding the +directory to `&runtimepath` as follows: ```vim +" If installed using Homebrew +set rtp+=/usr/local/opt/fzf + " If installed using git set rtp+=~/.fzf +``` +If you use [vim-plug](https://github.com/junegunn/vim-plug), the same can be +written as: + +```vim " If installed using Homebrew -set rtp+=/usr/local/opt/fzf +Plug '/usr/local/opt/fzf' + +" If installed using git +Plug '~/.fzf' ``` -But it's recommended that you use a plugin manager like -[vim-plug](https://github.com/junegunn/vim-plug). +But instead of separately installing fzf on your system (using Homebrew or +"git clone") and enabling it on Vim (adding it to `&runtimepath`), you can use +vim-plug to do both. ```vim +" PlugInstall and PlugUpdate will clone fzf in ~/.fzf and run install script Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' } + " Both options are optional. You don't have to install fzf in ~/.fzf + " and you don't have to run install script if you use fzf only in Vim. ``` ### Fedora |