docs: improve Installation section #1409
Merged
Conversation
This file contains hidden or 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
37dad9a to
9707083
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves the Installation section of the README by reorganizing the navigation links and adding detailed installation instructions for various platforms.
- Adds platform-specific installation instructions for Linux and MacOS (including Homebrew and MacPorts).
- Introduces sections for installing from sources, via Docker, and manual binary downloads.
Comments suppressed due to low confidence (1)
README.md:37
- The Table of Contents hierarchy shows inconsistent indentation levels across sections. Consider standardizing the indentation to clearly reflect the parent-child relationships among sections (e.g., grouping Linux, MacOS, Install from Sources, and Manual Binary Download under Installation) to improve readability.
- [Installation](#installation)
9707083 to
d7fc140
Compare
ccoVeille
reviewed
Jun 23, 2025
ccoVeille
approved these changes
Jun 24, 2025
chavacava
approved these changes
Jun 25, 2025
Closed
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.
This PR updates README with different installation methods.