Skip to content

Update README with single-threaded JetLS example #560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ufechner7 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with single-threaded JetLS example #560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion jetls-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ The extension will automatically use the `jetls` executable from your `PATH`.
## Launching configuration (advanced)

Most users do not need any further configuration beyond the installation steps
above. The following settings are available for advanced use cases.
above. The following settings are available for advanced use cases. For example, if you are
using plotting libraries like GLMakie or PyPlot, you have to run JETLS single-threaded
using the configuration shown below.

### Executable configuration

Expand All @@ -89,6 +91,17 @@ Configure the JETLS executable through the `jetls-client.executable` setting:
- **Array form** `string[]`: Use a local JETLS checkout for development, e.g,
(`["julia", "--startup-file=no", "--history-file=no", "--project=/path/to/JETLS", "-m", "JETLS", "serve"]`)

Example for launching JetLS single-threaded:
```json
{
"jetls-client.executable": {
"path": "jetls",
"threads": "1,0"
}
}
```
Save this in the `settings.json` file in the `.vscode` folder of your project.

### Communication channel

The extension automatically selects the most appropriate communication channel
Expand Down