Skip to content
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.

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

Provide more details on runtime directory #11026

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

aryzing
Copy link

@aryzing aryzing commented Jun 23, 2024

Provides more details on what to do with the runtime directory.

@David-Else
Copy link
Contributor

Thanks for the update, but I don't think:

searched by 'hx'

is very clear or grammatically correct. How about something more like the following, maybe you could use some or all of it?

Download the pre-built binaries from the GitHub Releases page. The downloaded tarball includes an hx binary and a runtime directory. To set up Helix:

  1. Add the hx binary to your system's $PATH to allow it to be used from the command line.
  2. Copy the runtime directory to a location that hx searches for runtime files. A typical location on Linux/macOS is ~/.config/helix/runtime.

To see the runtime directories that hx searches, run hx --health. If necessary, you can override the default runtime location by setting the HELIX_RUNTIME environment variable.

@aryzing
Copy link
Author

aryzing commented Jun 25, 2024

It's great, will use all of it

@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants