Make README.md point to INSTALL.md for instructions #1004
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
almet
reviewed
Nov 20, 2024
almet
reviewed
Nov 20, 2024
almet
approved these changes
Nov 21, 2024
Our repo's README.md should point to our INSTALL.md for installation instructions, and not the other way around. This fixes an issue with INSTALL.md pointing to a stale README.md version. Updating our README before tagging is not possible, since the latest version is the one that our users visit, and it can't point to download links that do not exist. Fixes #1003
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.
Our repo's README.md should point to our INSTALL.md for installation instructions, and not the other way around. This fixes an issue with INSTALL.md pointing to a stale README.md version. Updating our README before tagging is not possible, since the latest version is the one that our users visit, and it can't point to download links that do not exist.
Fixes #1003