Skip to content

Latest commit

 

History

History
192 lines (129 loc) · 5.3 KB

README.md

File metadata and controls

192 lines (129 loc) · 5.3 KB

vim-erlang-omnicomplete

vim-erlang-omnicomplete is an Erlang autocompletion plugin for Vim.

Table of Contents

Installation

Vim's built-in package manager

This is the recommended installation method if you use at least Vim 8 and you don't use another package manager.

Information about Vim's built-in package manager: :help packages.

Installation steps:

  1. Clone this repository (you can replace foo with the directory name of your choice):

    $ git clone https://github.com/vim-erlang/vim-erlang-omnicomplete.git \
          ~/.vim/pack/foo/start/vim-erlang-omnicomplete
  2. Restart Vim.

  3. Generate help page (replace foo with the same directory name as above):

    :helptags ~/.vim/pack/foo/start/vim-erlang-omnicomplete/doc
    
Pathogen

Information about Pathogen: Pathogen repository.

Installation steps:

  1. Clone this repository:

    $ git clone https://github.com/vim-erlang/vim-erlang-omnicomplete.git \
          ~/.vim/bundle/vim-erlang-omnicomplete
    
  2. Restart Vim.

  3. Generate help page:

    :Helptags
    
Vundle

Information about Vundle: Vundle repository.

Installation steps:

  1. Add vim-erlang-omnicomplete to your plugin list in .vimrc by inserting the line that starts with Plugin:

    call vundle#begin()
      [...]
      Plugin 'vim-erlang/vim-erlang-omnicomplete'
      [...]
    call vundle#end()
    
  2. Restart Vim.

  3. Run :PluginInstall.

Vim-Plug

Information about Vim-Plug: vim-plug repository.

Installation steps:

  1. Add vim-erlang-omnicomplete to your plugin list in .vimrc by inserting the line that starts with Plug:

    call plug#begin()
      [...]
      Plug 'vim-erlang/vim-erlang-omnicomplete'
      [...]
    call plug#end()
    
  2. Restart Vim.

  3. Run :PlugInstall.

Quick start

  1. Open an Erlang source file.

  2. Start typing something (e.g. li or io:fo).

  3. Without leaving insert mode, hit CTRL-X and then CTRL-O.

  4. After at most a few seconds, you should see a list of completions.

Documentation

Development

File layout

This repository contains the following files and directories:

Contributing