summaryrefslogtreecommitdiff
path: root/README.md
blob: 070389b2b1ff40d86f9c931a492a697aef28134d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
deoplete
========

Deoplete is the abbreviation of "dark powered neo-completion".  It
provides an asynchronous keyword completion system in the
current buffer.  Deoplete cannot be customized and doesn't currently have many
features.  It is provided for testing purposes.

**Note:** It is still an alpha version!  It is not for production use.

## Installation

**Note:** deoplete requires Neovim(latest is recommended) with Python3 enabled.
See [requirements](#requirements) if you aren't sure whether you have this.

1. Extract the files and put them in your Neovim directory
   (usually `~/.nvim/`).
2. Execute the `:UpdateRemotePlugins` and restart Neovim.
3. Execute the `:DeopleteEnable` command or set `let g:deoplete#enable_at_startup = 1`
   in your `.nvimrc`

## Requirements

deoplete requires Neovim with if\_python3.
If `:echo has("python3")` returns `1`, then you're done; otherwise, see below.

You can enable Python3 interface with pip:

    sudo pip3 install neovim

If you want to read the Neovim-python/python3 interface install documentation,
you should read `:help nvim-python`.

## Screenshots

Nothing...

## Configuration Examples

```vim
" Use deoplete.
let g:deoplete#enable_at_startup = 1
```