Skip to content

Commit caf6e8f

Browse files
committed
update readme
1 parent ecce363 commit caf6e8f

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,10 @@ ElixirLS supports the following environment variables.
469469

470470
</dl>
471471

472+
## Telemetry
473+
474+
ElixirLS language server sends telemetry information to the client via [LSP Telemetry notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#telemetry_event), [DAP Output event](https://microsoft.github.io/debug-adapter-protocol/specification#Events_Output) and [DAP ErrorResponse](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ErrorResponse). Telemetry data include usage, performance, environment info and error reports. Please refer to your client and/or extension documentation on telemetry.
475+
472476
## Acknowledgements and related projects
473477

474478
ElixirLS isn't the first frontend-independent server for Elixir language support. The original was [Alchemist Server](https://github.com/tonini/alchemist-server/), which powers the [Alchemist](https://github.com/tonini/alchemist.el) plugin for Emacs. Another project, [Elixir Sense](https://github.com/elixir-lsp/elixir_sense), builds upon Alchemist and powers the [Elixir plugin for Atom](https://github.com/msaraiva/atom-elixir) as well as another VS Code plugin, [VSCode Elixir](https://github.com/fr1zle/vscode-elixir). ElixirLS uses Elixir Sense for several code insight features. Credit for those projects goes to their respective authors.

guides/incomplete-installation.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
1+
# Incomplete OTP installations
2+
13
Incomplete installations is a frequent cause of ElixirLS failures. Generally
24
this is resolved by:
3-
* Installing elixir and erlang with ASDF https://github.com/asdf-vm/asdf
5+
6+
* Installing elixir and erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)
47
(recommended)
5-
* Installing a full version of Erlang via the package manager
8+
* Installing a full version of Erlang/OTP via the package manager
69

710
## dialyzer missing
811

9-
On Ubuntu this is caused by the required `erlang-dialyzer` package not being
10-
installed. For Ubuntu this can be fixed by running `sudo apt-get install erlang
11-
erlang-dialyzer` or installing Elixir and Erlang via ASDF
12-
https://github.com/asdf-vm/asdf
12+
On *Ubuntu* this is caused by the required `erlang-dialyzer` package not being
13+
installed. For Ubuntu this can be fixed by running
14+
15+
```bash
16+
sudo apt-get install erlang erlang-dialyzer
17+
```
18+
19+
or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)
1320

1421
Relevant issue: https://github.com/elixir-lsp/vscode-elixir-ls/issues/134
1522

1623
## edoc missing
1724

18-
On fedora this is caused by the required `erlang-edoc `package not being
19-
installed. For fedora this can be fixed by running `sudo dnf install erlang
20-
erlang-edoc` or installing Elixir and Erlang via ASDF
21-
https://github.com/asdf-vm/asdf
25+
On *Fedora* this is caused by the required `erlang-edoc` package not being
26+
installed. For fedora this can be fixed by running
27+
28+
```bash
29+
sudo dnf install erlang erlang-edoc
30+
```
31+
32+
or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)
2233

2334
Relevant issue: https://github.com/elixir-lsp/elixir-ls/issues/431

0 commit comments

Comments
 (0)