Improve and update the installation documentation #6809
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
the-mikedavis
approved these changes
Apr 19, 2023
pascalkuthe
approved these changes
Apr 19, 2023
Triton171
pushed a commit
to Triton171/helix
that referenced
this pull request
Jun 18, 2023
wes-adams
pushed a commit
to wes-adams/helix
that referenced
this pull request
Jul 4, 2023
smortime
pushed a commit
to smortime/helix
that referenced
this pull request
Jul 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before the release of 23.03.1, I wanted to address a few issues that have been bothering me and make some general improvements.
Primarily, I corrected grammar and clarity issues, but I also added a new requirements section. Initially, we had agreed that this section was unnecessary as everyone knew that the Rust toolchain was mandatory. However, since a c++14 requirement was recently added, I included the Rust toolchain requirement in the new section as well. I think it is much better now as I also added the
If you are using the musl-libc...section to the requirements up front, it made no sense to have it after you had tried to install Helix as it would have failed by then!I think there was some debate about numbering
Clone the repositoryandcompile from source, but with the new requirements things seemed a bit harder to follow without them.