Skip to content

Commit 727053f

Browse files
authored
Document that there should be no output on setup script (elixir-editors#468)
1 parent 2dbbb6c commit 727053f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,11 @@ if available, but that may not be what you want or need. Therefore, prior to exe
246246

247247
Note: for windows the local setup script path is `%APPDATA%/elixir_ls/setup.bat` (which is often `C:\Users\<username>\AppData\Roaming\elixir_ls`)
248248

249+
Note: It is important that the setup script not print any output. On linux this might be
250+
accomplished by adding `>/dev/null` and/or `2>/dev/null` at the end of any line that produces
251+
output, and for a windows batch script you will want `@echo off` at the top and `>nul` on every
252+
line.
253+
249254
## Acknowledgements and related projects
250255

251256
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.

0 commit comments

Comments
 (0)