Use shell blocks for readme - #369
Open
sipke wants to merge 3 commits into
Open
Conversation
added 3 commits
August 31, 2026 10:12
Multiple lines of text are concatenated so use a code block for the supported targets and example usage so they are on individual lines. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Use the markdown shell block instead of prepending $ to command so that users can copy the block, as supported in github and IDEs. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
With the code block indented the tag lines ``` were shown in readme, so remove the indentation to show only the licence line. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
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
1 participant
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.
To address documentation issues
OpenAMP/openamp-docs#73
OpenAMP/openamp-docs#84
Update code blocks to not use prompt ($) on command line so that github and IDE copy button provides exact command line.