Use shell block for commands in readme file#80
Open
sipke wants to merge 1 commit intoOpenAMP:mainfrom
Open
Conversation
To allow the reader to easily copy the commands, use the shell markdown block. Some IDEs provide a convenient terminal launch button. e.g Pycharm in their bundled Markdown renderer will execute the commands in the built in terminal. Visual Studio code also has a plugin for it. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
arnopo
approved these changes
Dec 1, 2025
Collaborator
arnopo
left a comment
arnopo
left a comment
There was a problem hiding this comment.
Much better from my point of view.
Let’s wait for a few more feedbacks, but this could also be applied to other OpenAMP repositories.
Collaborator
|
@edmooring @tnmysh , could you have a look please |
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
2 participants
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 allow the reader to easily copy the commands, use the shell markdown block.
Some IDEs provide a convenient terminal launch button. e.g Pycharm in their bundled Markdown renderer will execute the commands in the built in terminal.
Visual Studio code also has a plugin for it.
mark-down-shell-runner
Addresses issue #73 for openamp-docs and if this is suitable can make same changes in source code repositories.