chore(readme): update install code fences #614
Merged
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.
👋🏻 Hey friends, I enjoy using this project, and thought I'd push up a slightly opinionated take on the install scripts in the Readme.
The story:
I often go to the readme and press the copy to clipboard button that GitHub renders:
and then paste it into my terminal. However, this adds a preceeding
$
, which causes the command to fail:$ $ go install github.com/pressly/goose/v3/cmd/goose@latest $: command not found
The change:
The change adds a code fence with the
shell
language, which (at least on my browser and os) looks idential in the GH UI, but when I copy the command to the clipboard, I can use it without modification.To see what it looks like, here's the link to the install section in my fork: https:/greyscaled/goose#install
and a side-by-side (original left, my fork right):
LMK what you think, thanks!