-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
docs[install/pre-build binaries]: add runtime setup #10693
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just some small formatting nits
Co-authored-by: Michael Davis <[email protected]>
I kind of disagree with this though, it instructs the user to put system files under their user directory. It's also likely the user will forget to update this in the future. |
I think we agree that previously, it was also a problem, right? The user folder is an example that works for most of the users, but I expect that those who need to install it for multiple users will know how to do it in another way. @archseer do you have some suggestions about how to improve it? |
The preferred route should be a symlink since that should be easier to update. But the binary also looks for runtime files co-located with it so it can be used straight away after unzipping |
Hmm, I didn't know that, so the docs are not as wrong as I thought. I still think that it's nice to explain the |
Hi!
Context
I installed my helix by pre-build binary following the book, and the highlight didn't work.
I found the issue #1098 with the problem and the solution, and moving the runtime to the correct location the syntax highlight started to work.
What these issue solve?
These issues update the installation of the pre-build binary docs to add the
runtime
folder information, so people who follow the instructions will have the syntax highlighting working on the first time.Other possible implementation
The book explains how to setup the runtime folder on the building by the source section, but I didn't find it on the first time because it was too far away and in the build by source section, so I didn't expect do need to follow these steps, but we can also make one session just for the runtime and like both the binary installation and by source to it