Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszsamson committed Oct 22, 2023
1 parent ecce363 commit caf6e8f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,10 @@ ElixirLS supports the following environment variables.

</dl>

## Telemetry

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.

## Acknowledgements and related projects

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.
Expand Down
31 changes: 21 additions & 10 deletions guides/incomplete-installation.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,34 @@
# Incomplete OTP installations

Incomplete installations is a frequent cause of ElixirLS failures. Generally
this is resolved by:
* Installing elixir and erlang with ASDF https://github.com/asdf-vm/asdf

* Installing elixir and erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)
(recommended)
* Installing a full version of Erlang via the package manager
* Installing a full version of Erlang/OTP via the package manager

## dialyzer missing

On Ubuntu this is caused by the required `erlang-dialyzer` package not being
installed. For Ubuntu this can be fixed by running `sudo apt-get install erlang
erlang-dialyzer` or installing Elixir and Erlang via ASDF
https://github.com/asdf-vm/asdf
On *Ubuntu* this is caused by the required `erlang-dialyzer` package not being
installed. For Ubuntu this can be fixed by running

```bash
sudo apt-get install erlang erlang-dialyzer
```

or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)

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

## edoc missing

On fedora this is caused by the required `erlang-edoc `package not being
installed. For fedora this can be fixed by running `sudo dnf install erlang
erlang-edoc` or installing Elixir and Erlang via ASDF
https://github.com/asdf-vm/asdf
On *Fedora* this is caused by the required `erlang-edoc` package not being
installed. For fedora this can be fixed by running

```bash
sudo dnf install erlang erlang-edoc
```

or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx)

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

0 comments on commit caf6e8f

Please sign in to comment.