Browse Source

Update README.md with instructions for Zed (#163)

pull/164/head
David Barton 4 months ago committed by GitHub
parent
commit
142ec36618
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 21
      README.md

21
README.md

@ -200,6 +200,7 @@ Example configuration for some editors are given in the following sections. @@ -200,6 +200,7 @@ Example configuration for some editors are given in the following sections.
- [VS Code](#vs-code)
- [Emacs](#emacs)
- [Helix](#helix)
- [Zed](#zed)
> [!IMPORTANT]
> Note that these configurations depend on third party plugins. They works as advertised but
@ -302,6 +303,26 @@ auto-format = false @@ -302,6 +303,26 @@ auto-format = false
formatter = { command = "julia" , args = ["--project=@runic", "--startup-file=no", "-e", "using Runic; exit(Runic.main(ARGS))"] }
```
#### Zed
Runic can be used as a formatter in [Zed](https://zed.dev/). You can configure Runic as a
local formatter by adding the following entry to your `settings.json`. This assumes Runic
is installed in the `@runic` shared project as suggested in the [Installation](#installation)
section above. Adjust the `--project` flag if you installed Runic somewhere else.
```json
"languages": {
"Julia": {
"formatter": {
"external": {
"command": "julia",
"arguments": ["--project=@runic", "--startup-file=no", "-e", "using Runic; exit(Runic.main(ARGS))"]
}
}
}
}
```
### Git integration
The [`git-runic`](https://github.com/fredrikekre/Runic.jl/blob/master/bin/git-runic)

Loading…
Cancel
Save