Skip to content

Commit d90553b

Browse files
authored
Updated troubleshooting section on README.md (#23)
1 parent 0f4fba1 commit d90553b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,12 @@ Plug 'amiralies/coc-elixir', {'do': 'yarn install && yarn prepack'}
3636

3737
### Server fails to start
3838

39-
If, for some reason, the language server fails to start, you can try doing a manual installation of [ElixirLS](https://github.com/elixir-lsp/elixir-ls) to fix the problem.
39+
Upon upgrading `coc-elixir` it is possible that the binary files were compiled
40+
using an OTP or Elixir version that differ from the ones you have installed.
41+
When this happens, the language server will fail to start.
42+
43+
You can build [ElixirLS](https://github.com/elixir-lsp/elixir-ls) yourself to
44+
solve this:
4045

4146
Start by building a binary of ElixirLS from its source:
4247

@@ -46,14 +51,20 @@ cd ~/.elixir-ls
4651
mix deps.get && mix compile && mix elixir_ls.release -o release
4752
```
4853

49-
Afterwards, create or update your ~/.vim/coc-settings.json file and add this line:
54+
Afterwards, create or update your coc-settings file and add this line:
5055

5156
```json
5257
{
5358
"elixir.pathToElixirLS": "~/.elixir-ls/release/language_server.sh"
5459
}
5560
```
5661

62+
To open your coc-settings file directly from Vim or Nvim, you can use this command:
63+
64+
```
65+
:CocConfig
66+
```
67+
5768
Doing these steps should make this plugin work with [CoC](https://github.com/neoclide/coc.nvim).
5869

5970
## License

0 commit comments

Comments
 (0)