Add documentation for hx --health (#2357)

This commit is contained in:
Robert Walter 2022-05-02 23:46:25 +02:00 committed by GitHub
parent ac2ea800ce
commit fba198c1e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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.