Update README to Allow Install and Run Commands to Be Copied As Is #11722
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.
The current version of the README contains extra text that make commands fail.
Example:
But if we use the command as is, we get an error:
My humble proposal is to align the README with other parts of the README, which adopts a similar format (without the dollar sign and output as part of the command text).
Here is an example currently in the README, at the bottom:
Additionally, this format is good as it aligns with other documentation formats, such as that used by GitHub. Here is an example from the GitHub docs on generating new SSH keys: