aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Walter2022-05-02 21:46:25 +0000
committerGitHub2022-05-02 21:46:25 +0000
commitfba198c1e0d20eac4a2af151608827057d4f36d5 (patch)
treea5d5d780b10075f93fcba746092bdec59614a0e9
parentac2ea800ce267b9ed3da5f743085f0afe8460473 (diff)
Add documentation for `hx --health` (#2357)
-rw-r--r--book/src/install.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/book/src/install.md b/book/src/install.md
index 34d8b651..cbd2c028 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -66,6 +66,15 @@ via the `HELIX_RUNTIME` environment variable.
|windows |`xcopy runtime %AppData%/helix/runtime`|
|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
+## Finishing up the installation
+
+To make sure everything is set up as expected you should finally run the helix healthcheck via
+```
+hx --health
+```
+For more information on the information displayed in the healthcheck results refer to [Healthcheck](https://github.com/helix-editor/helix/wiki/Healthcheck).
+
+
## Building tree-sitter grammars
Tree-sitter grammars must be fetched and compiled if not pre-packaged.