Skip to content

Commit 53f6f67

Browse files
rskimartskins
authored andcommitted
Fixup development from source instructions (autozimu#1137)
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.
1 parent 563decc commit 53f6f67

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# Prerequisites
22

3-
- [rust] toolchain
3+
- [rust] toolchain or [nix]
44

55
[rust]: https://www.rust-lang.org
6+
[nix]: https://nixos.org/
67

78
# Development
89

10+
Clone this repo into some place, e.g., `~/.vim-plugins`
11+
12+
```sh
13+
mkdir -p ~/.vim-plugins
14+
cd ~/.vim-plugins
15+
git clone https://github.com/autozimu/LanguageClient-neovim.git
16+
cd LanguageClient-neovim
17+
git checkout dev
18+
# nix users can execute nix-shell at this point
19+
make dev
20+
```
21+
22+
Add this plugin to vim/neovim `runtimepath`,
23+
24+
```vim
25+
set runtimepath+=~/.vim-plugins/LanguageClient-neovim
26+
```
27+
928
Put those settings inside vimrc,
1029

1130
```vim
@@ -14,7 +33,7 @@ let g:LanguageClient_loggingLevel = 'INFO' " Optional, use higher logging level
1433
```
1534

1635
- Make necessary changes.
17-
- Execute `make` to build, format and [lint][clippy].
36+
- Execute `make dev` to build, format and [lint][clippy].
1837
- Running separate vim/neovim. Verify changes.
1938
- Run tests. (See below section)
2039

0 commit comments

Comments
 (0)