Skip to content

Commit

Permalink
Update elm-vim instructions to be more clear for advanced users
Browse files Browse the repository at this point in the history
  • Loading branch information
avh4 committed Sep 17, 2020
1 parent 76742e7 commit 50adeb1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -216,8 +216,13 @@ The default behavior of `elm-format`-approved plugins is to format Elm files on

### elm-vim installation

> If you are an advanced vim user and already have a preferred vim plugin installation method,
> you may prefer to refer to the [official elm-vim installation instructions](https://github.com/ElmCast/elm-vim#install).
> The instructions below are for those who need a step-by-step walkthrough of how to get the plugin set up.
1. Install elm-format
1. Install [vim-plug](https://github.com/junegunn/vim-plug) ([official instructions](https://github.com/junegunn/vim-plug#installation))
NOTE: if you are using neovim, you will need to refer to the official instructions.

1. Download vim-plug:

Expand All @@ -226,16 +231,14 @@ The default behavior of `elm-format`-approved plugins is to format Elm files on
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
```

1. Make sure there is a section like this in your `~/.vimrc`:
1. Make sure `~/.vimrc` exists and has a section like this:

```vim
call plug#begin('~/.vim/plugged')
" ... any active plugins
call plug#end()
```



1. Install elm-vim ([official instructions](https://github.com/ElmCast/elm-vim#install))

1. Add `Plug 'elmcast/elm-vim'` to the `plug#begin` plugin section in your `~/.vimrc`
Expand Down

0 comments on commit 50adeb1

Please sign in to comment.