mirror of
https://github.com/jremmen/vim-ripgrep.git
synced 2025-12-27 04:04:58 +08:00
Improved README: install and prettier
This commit is contained in:
parent
ec87af6b69
commit
4bd10b2c69
1 changed files with 35 additions and 8 deletions
43
README.md
43
README.md
|
|
@ -1,10 +1,43 @@
|
|||
# vim-ripgrep
|
||||
|
||||
## Usage
|
||||
|
||||
Search using ripgrep. The word under cursor will be searched if no argument is passed to `Rg`.
|
||||
|
||||
:Rg <string|pattern>
|
||||
|
||||
Word under cursor will be searched if no argument is passed to `Rg`
|
||||
|
||||
## configuration
|
||||
Show root search dir:
|
||||
|
||||
:RgRoot
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
Using [Vim-Plug](https://github.com/junegunn/vim-plug):
|
||||
|
||||
Add this to your `~/.vimrc` and run `:PlugInstall`
|
||||
```vim
|
||||
Plug 'jremmen/vim-ripgrep'
|
||||
```
|
||||
|
||||
|
||||
Using [Vundle](https://github.com/VundleVim/Vundle.vim):
|
||||
|
||||
Add this to your `~/.vimrc` and run `:PluginInstall`
|
||||
```vim
|
||||
Plugin 'jremmen/vim-ripgrep'
|
||||
```
|
||||
|
||||
|
||||
Using [Pathogen](https://github.com/tpope/vim-pathogen):
|
||||
|
||||
Ensure you have `execute pathogen#infect()` in your `~/.vimrc` file and run:
|
||||
```bash
|
||||
git clone https://github.com/jremmen/vim-ripgrep.git ~/.vim/bundle
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
| Setting | Default | Details
|
||||
|
|
@ -16,9 +49,3 @@ Word under cursor will be searched if no argument is passed to `Rg`
|
|||
| g:rg_derive_root | false | true if you want to find project root from cwd
|
||||
| g:rg_root_types | ['.git'] | list of files/dir found in project root
|
||||
| g:rg_window_location | botright | quickfix window location
|
||||
|
||||
## misc
|
||||
|
||||
Show root search dir
|
||||
|
||||
:RgRoot
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue