Skip to content

Commit

Permalink
Fix #179 update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Jan 21, 2017
1 parent d3adbd3 commit 68ceee0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Expand Up @@ -13,6 +13,13 @@ Dein.vim is a dark powered Vim/Neovim plugin manager.

## Quick start

Note: You must define the installation directory before to use dein. It
depends on your usage.
For example, "~/.vim/bundles" or "~/.cache/dein" or "~/.local/share/dein".
dein.vim has not define the default installation directory.
You must not set the installation directory under "~/.vim/plugin" or
"~/.config/nvim/plugin".

#### If you are using Unix/Linux or Mac OS X.

1. Run below script.
Expand Down Expand Up @@ -65,6 +72,14 @@ Dein.vim is a dark powered Vim/Neovim plugin manager.

* neovim/Vim8 asynchronous API installation support

* Local plugin support

* Non github plugins support

* Go like clone directory name ex:"github.com/{user}/{repository}"

* Merge the plugins directories automatically to avoid long 'runtimepath'

## Future works (not implemented yet)

* Other types support (zip, svn, hg, ...)
Expand Down
21 changes: 21 additions & 0 deletions doc/dein.txt
Expand Up @@ -42,6 +42,14 @@ Concepts are:

* neovim/Vim8 asynchronous API installation support

* Local plugin support

* Non github plugins support

* Go like clone directory name ex:"github.com/{user}/{repository}"

* Merge the plugins directories automatically to avoid long 'runtimepath'


==============================================================================
USAGE *dein-usage*
Expand All @@ -53,6 +61,7 @@ Run this command to update your plugins:
>
:call dein#update()
<
Note: The plugins are not updated automatically.

==============================================================================
INSTALL *dein-install*
Expand All @@ -63,6 +72,13 @@ Requirements:

First of all, git clone the repository.

Note: You must define the installation directory before to use dein. It
depends on your usage.
For example, "~/.vim/bundles" or "~/.cache/dein" or "~/.local/share/dein".
dein.vim has not define the default installation directory.
You must not set the installation directory under "~/.vim/plugin" or
"~/.config/nvim/plugin".

Note: You need to have git installed.
>
$ mkdir -p ~/.vim/bundle/repos/github.com/Shougo/dein.vim
Expand Down Expand Up @@ -1095,6 +1111,11 @@ Q: I have got prompted for my github username and I have to kill the editor...
A: You have specified wrong/removed repository name. You should check the
repository.

Q: Why dein.vim merges the plugins directories automatically?

A: To avoid long 'runtimepath'. If 'runtimepath' is long, Vim/neovim loading
performance will be bad.

==============================================================================
COMPATIBILITY *dein-compatibility*

Expand Down

0 comments on commit 68ceee0

Please sign in to comment.