From 21ce1471fa6de40d29731e4649276e5796400857 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Wed, 25 Jun 2025 21:27:27 +0200 Subject: [PATCH] Unify editor integration docs. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4b6db9e..e95ae62 100644 --- a/README.md +++ b/README.md @@ -213,7 +213,7 @@ repository for installation and setup instructions. Runic is not (yet) available directly in conform so the following configuration needs to be passed to the setup function. 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 elsewhere. +`--project` flag if you installed Runic somewhere else. ```lua require("conform").setup({ @@ -246,7 +246,9 @@ Runic can be used as a formatter in [VS Code](https://code.visualstudio.com/) us extension [Custom Local Formatters](https://marketplace.visualstudio.com/items?itemName=jkillian.custom-local-formatters&ssr=false#overview). After installing the extension you can configure Runic as a local formatter by adding the -following entry to your `settings.json`: +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 "customLocalFormatters.formatters": [ @@ -275,7 +277,9 @@ Refer to the apheleia repository for installation and setup instruction. Runic is not (yet) available directly in apheleia so the following configuration needs to be added to your `.emacs`. -This assumes that Runic is installed in the `@runic` shared project as suggested in the [Installation](#installation) section above. +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. ``` (push `(runic . ("julia" "--project=@runic" "--startup-file=no" "-e" "using Runic; exit(Runic.main(ARGS))" "--")) apheleia-formatters) @@ -288,7 +292,7 @@ Runic can be used as a formatter in [Helix](https://helix-editor.com/). Configur `:format` command to use Runic for julia code by adding the following to the `languages.toml` configuration file. 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 elsewhere. +`--project` flag if you installed Runic somewhere else. ``` [[language]]