Skip to content

Commit d64f237

Browse files
committed
update readme
1 parent d2463ad commit d64f237

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ For VSCode install the extension: https://marketplace.visualstudio.com/items?ite
8888

8989
Elixir:
9090

91-
- 1.12.3 minimum
91+
- 1.12 minimum
9292

9393
Erlang:
9494

@@ -108,7 +108,7 @@ Currently there is a limit of 100 breakpoints.
108108

109109
In order to debug modules in `.exs` files (such as tests), they must be specified under `requireFiles` in your launch configuration so they can be loaded and interpreted prior to running the task. For example, the default launch configuration for "mix test" in the VS Code plugin looks like this:
110110

111-
```
111+
```json
112112
{
113113
"type": "mix_task",
114114
"name": "mix test",
@@ -128,7 +128,7 @@ In order to debug modules in `.exs` files (such as tests), they must be specifie
128128

129129
In order to debug a single test or a single test file it is currently necessary to modify `taskArgs` and make sure no other tests are required in `requireFiles`.
130130

131-
```
131+
```json
132132
{
133133
"type": "mix_task",
134134
"name": "mix test",
@@ -148,7 +148,7 @@ In order to debug a single test or a single test file it is currently necessary
148148

149149
Use the following launch config to debug phoenix apps
150150

151-
```
151+
```json
152152
{
153153
"type": "mix_task",
154154
"name": "phx.server",
@@ -164,7 +164,7 @@ Please make sure that `startApps` is not set to `true` as it prevents phoenix fr
164164

165165
Please note that due to `:int` limitation NIF modules cannot be interpreted and need to be excluded via `excludeModules` option. This option can be also used to disable interpreting for some modules when it is not desirable e.g. when performance is not satisfactory.
166166

167-
```
167+
```json
168168
{
169169
"type": "mix_task",
170170
"name": "mix test",
@@ -291,7 +291,15 @@ https://github.com/elixir-lsp/elixir-ls/issues/364#issuecomment-829589139
291291

292292
## Building and running
293293

294-
Run `mix compile`, then `mix elixir_ls.release -o <release_dir>`. This builds the language server and debugger as a set of `.ez` archives and creates `.sh` and `.bat` scripts to launch them.
294+
In order to build a release use the following commands.
295+
296+
```bash
297+
mix deps.get
298+
MIX_ENV=prod mix compile
299+
MIX_ENV=prod mix elixir_ls.release -o <release_dir>
300+
```
301+
302+
This builds the language server and debugger as a set of `.ez` archives and creates `.sh` and `.bat` scripts to launch them.
295303

296304
If you're packaging these archives in an IDE plugin, make sure to build using the minimum supported OTP version for the best backwards-compatibility. Alternatively, you can use a [precompiled release](https://github.com/elixir-lsp/elixir-ls/releases).
297305

0 commit comments

Comments
 (0)