Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
iberianpig committed Jul 13, 2020
1 parent f55c7f3 commit ae0d30c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
Vim plugin to use [Tig](https://github.com/jonas/tig) as a git client.
* Seamless switching between Vim and Tig
* Adding buffer in the same process not a child of Tig process.
* Open files in tabs or in vertically/horizontal split windows on Vim from Tig
* Open files in tabs or in vertically / horizontal split windows on Vim from Tig
* Dynamically defining keymaps on Tig
* Support Vim8 / NeoVim terminal
* Open diff-mode side by side at the selected commit from Tig

[![https://gyazo.com/181fef546cced7ca6dc651dff59cd1bf](https://i.gyazo.com/181fef546cced7ca6dc651dff59cd1bf.gif)](https://gyazo.com/181fef546cced7ca6dc651dff59cd1bf)

Expand Down Expand Up @@ -35,9 +37,7 @@ NeoBundle 'rbgrouleff/bclose.vim'

## Usage

### Available Command

#### Keymap on Tig
### Keymap on Tig

Following commands are available on tig launched from tig-explorer
```
Expand All @@ -50,7 +50,7 @@ e, <Ctrl-o>: edit on existing tab
When a commit is available (in main, blame, tree, refs view) view, the version of the file corresponding to this commit
will be open instead of the version in the working directory. Split versions will open the two buffer in diff mode.

##### Customize Keymap on Tig
#### Customize Keymap on Tig
Following keymap is defined as defaut
```vim
let g:tig_explorer_keymap_edit = '<C-o>'
Expand All @@ -59,7 +59,7 @@ let g:tig_explorer_keymap_split = '<C-s>'
let g:tig_explorer_keymap_vsplit = '<C-v>'
```

#### Keymap on Vim
### Keymap on Vim

Add following script to ~/.vimrc

Expand All @@ -86,6 +86,17 @@ nnoremap <Leader>cg :<C-u>:TigGrep<Space><C-R><C-W><CR>
nnoremap <Leader>b :TigBlame<CR>
```

### Other options

By default tig-explorer will use the build terminal if available.
To force launching tig-explorer as shell command you can add the following to
~/.vimrc

```vim
" don't use builtin terminal
let g:tig_explorer_use_builtin_term=0
```

## Support

[![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/iberianpig)
3 changes: 3 additions & 0 deletions doc/tig-explorer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,15 @@ And you can add following script to ~/.vimrc
" open tig blame with current file
nnoremap <Leader>b :TigBlame<CR>
<

By default tig-explorer will use the build terminal if available.
To force launching tig-explorer as shell command you can add the following to
~/.vimrc

>
" don't use builtin terminal
let g:tig_explorer_use_builtin_term=0
<

==============================================================================
SUPPORT *tig-explorer-support*
Expand Down

0 comments on commit ae0d30c

Please sign in to comment.