Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
I have confirmed installation procudures(install from github
repository).
  • Loading branch information
hankei6km committed Feb 16, 2018
1 parent 9a577ad commit 11c8cb6
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 12 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,64 @@
# starttig

starttig is vim plug-in to support starting [tig](http://jonas.nitro.dk/tig/) from vim. it's enable options/refs input completion and suppress hit-enter prompt.
starttig is Vim plug-in to support starting [Tig](http://jonas.nitro.dk/tig/) from Vim. it's enable options/refs input completion and suppress hit-enter prompt.

## Requirements

* vim
* tig
* Vim
* Tig

## Installation

* Install startig like as general vim plug-ins
### Installation with Vim package management(Vim 8 on linux)

```bash
# ie.
mkdir -p ~/.vim/pack/git-plugins/start
git clone https://github.com/hankei6km/starttig.vim.git ~/.vim/pack/git-plugins/start/stattig.vim
```

Generating Vim help files.

```bash
# ie.
vim "+silent! helptags ALL" +qall
```

### Installation with [Vundle](https://github.com/VundleVim/Vundle.vim)

```vim
Plugin 'hankei6km/starttig.vim'
```

## Usage

start `tig`
Starting to `tig`

```vim
:Stig
```

start `tig` with `topic/foo`
Starting to `tig` with `topic/foo`

```vim
:Stig topic/foo
```

start `tig blame` with current edit file
Starting to `tig blame` with current editing file

```vim
:Stig blame
```

## Customize

Change command name.
Customizing command name.

```vim
call starttig#SetTigCmdName("Tig")
```

Set default options (it's enable when passed options is blanked).
Default options (it's enable when passed options is blanked).

```vim
call starttig#SetTigBlankedOpt(["--all"])
Expand Down
23 changes: 20 additions & 3 deletions README_ja.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,32 @@
# starttig

starttig は、 Vim からの [tig](http://jonas.nitro.dk/tig/) 開始をサポートするVimプラグインです。tig のオプション等の補完やコマンド終了後の hit-enter プロンプトを抑止します。
starttig は、 Vim からの [Tig](http://jonas.nitro.dk/tig/) 開始をサポートするVimプラグインです。Tig のオプション等の補完やコマンド終了後の hit-enter プロンプトを抑止します。

## Requirements

* vim
* Vim
* tig

## Installation

* 一般的な Vim スクリプトと同じようにインストールできます。
### Vim パッケージ管理によるインストール(Vim 8 on linux).

```bash
mkdir -p ~/.vim/pack/git-plugins/start
git clone https://github.com/hankei6km/starttig.vim.git ~/.vim/pack/git-plugins/start/stattig.vim
```

help ファイルの作成例.

```bash
vim "+silent! helptags ALL" +qall
```

### [Vundle](https://github.com/VundleVim/Vundle.vim) によるインストール.

```vim
Plugin 'hankei6km/starttig.vim'
```

## Usage

Expand Down

0 comments on commit 11c8cb6

Please sign in to comment.