Skip to content

Improve installation instructions#91

Merged
cgwalters merged 1 commit intobootc-dev:mainfrom
senekor:patch-1
Oct 25, 2025
Merged

Improve installation instructions#91
cgwalters merged 1 commit intobootc-dev:mainfrom
senekor:patch-1

Conversation

@senekor
Copy link
Copy Markdown
Contributor

@senekor senekor commented Oct 24, 2025

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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
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>
Copy link
Copy Markdown
Collaborator

@cgwalters cgwalters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@cgwalters cgwalters enabled auto-merge (rebase) October 25, 2025 15:10
@cgwalters cgwalters merged commit d060e68 into bootc-dev:main Oct 25, 2025
4 checks passed
@senekor senekor deleted the patch-1 branch November 15, 2025 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants