Improve installation instructions#91
Merged
cgwalters merged 1 commit intobootc-dev:mainfrom Oct 25, 2025
senekor:patch-1
Merged
Improve installation instructions#91cgwalters merged 1 commit intobootc-dev:mainfrom senekor:patch-1
cgwalters merged 1 commit intobootc-dev:mainfrom
senekor:patch-1
Conversation
There was a problem hiding this comment.
Code Review
This pull request improves the installation instructions in README.md by using cargo install to fetch directly from the git repository, which is a nice simplification. I've suggested a small formatting change to make the command more readable and consistent with the rest of the document.
One other thing to consider is that docs/src/installation.md also contains build-from-source instructions which are now inconsistent with the README.md. It would be great to update that file as well, either in this PR or a follow-up, to ensure all documentation is aligned.
Since cargo can install from git repository URLs directly, a separate `git clone` step is unnecessary. Reference the detailed installation page from the readme to avoid duplication and inconsistencies. Signed-off-by: Remo Senekowitsch <remo@buenzli.dev>
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
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.
Since cargo can install from git repository URLs directly, a separate
git clonestep is unnecessary.Reference the detailed installation page from the readme to avoid duplication and inconsistencies.