Fixup development from source instructions
CONTRIBUTING.md suggests running `make`, which builds the binary in
release mode. It also suggests setting LanguageClient_devel, so vim ends
up trying to use the debug binary. Fixup that inconsistency and add a
few more tidbits to make the instructions more complete.
# Prerequisites
-- [rust] toolchain
+- [rust] toolchain or [nix]
[rust]: https://www.rust-lang.org
+[nix]: https://nixos.org/
# Development
+Clone this repo into some place, e.g., `~/.vim-plugins`
+
+```sh
+mkdir -p ~/.vim-plugins
+cd ~/.vim-plugins
+git clone https://github.com/autozimu/LanguageClient-neovim.git
+cd LanguageClient-neovim
+git checkout dev
+# nix users can execute nix-shell at this point
+make dev
+```
+
+Add this plugin to vim/neovim `runtimepath`,
+
+```vim
+set runtimepath+=~/.vim-plugins/LanguageClient-neovim
+```
+
Put those settings inside vimrc,
```vim
@@ -14,7 +33,7 @@ let g:LanguageClient_loggingLevel = 'INFO' " Optional, use higher logging level
```
- Make necessary changes.
-- Execute `make` to build, format and [lint][clippy].
+- Execute `make dev` to build, format and [lint][clippy].
- Running separate vim/neovim. Verify changes.
- Run tests. (See below section)
