Skip to content

Commit

Permalink
Merge pull request #66 from ianchanning/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
euclio committed Sep 14, 2018
2 parents d2bbffe + 5acec03 commit 61a0ba1
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ pre-installed, the system Vim might be too old (see `vim --version`).
This plugin supports Windows, macOS, and Linux.

In addition to Neovim or Vim, vim-markdown-composer requires a distribution of
[Rust] with `cargo`. To easily install the lastest version of Rust with `cargo`,
check out [rustup.rs](https://www.rustup.rs/).
[Rust] with `cargo`. Check out the [Rust installation guide].

vim-markdown-composer officially targets the latest version of [stable Rust].

Expand All @@ -29,6 +28,8 @@ vim-markdown-composer officially targets the latest version of [stable Rust].
Use whatever plugin manager you like. If you aren't familiar with plugin
managers, I recommend [vim-plug].

### vim-plug

Here's an an example of managing installation with vim-plug:

```vim
Expand All @@ -45,6 +46,26 @@ endfunction
Plug 'euclio/vim-markdown-composer', { 'do': function('BuildComposer') }
```

### Vundle

In your `.vimrc`:

```vim
Plugin 'euclio/vim-markdown-composer'
```

Once you have installed the plugin, close Vim/Neovim then (on Linux):

```sh
$ cd ~/.vim/bundle/vim-markdown-composer/
# Vim
$ cargo build --release --no-default-features --features json-rpc
# Neovim
$ cargo build --release
```

### Other plugin managers

You should run `cargo build --release` in the plugin directory after
installation. Vim support requires the `json-rpc` cargo feature.

Expand All @@ -71,3 +92,4 @@ previews.
[msgpack-rpc]: https://github.com/msgpack-rpc/msgpack-rpc
[aurelius]: https://github.com/euclio/aurelius
[stable Rust]: https://www.rust-lang.org/downloads.html
[Rust installation guide]: https://www.rust-lang.org/en-US/install.html

0 comments on commit 61a0ba1

Please sign in to comment.