Cleanup of README.md #342
Merged
Cleanup of README.md #342
Conversation
This file contains 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
|
Text (and similar, e.g. Markdown) files in ROS 2 are intentionally not wrapped. We use one-sentence-per-line because it makes diffs in PRs much easier to handle. |
|
Understood. I'll unwrap everything and resubmit. |
|
@gbiggs I've fixed the wrapping as requested. |
Timple
reviewed
Feb 4, 2022
gbiggs
reviewed
Feb 7, 2022
|
@gbiggs Thanks for suggestions! I had to do a force push to signoff the commits and get them past the DCO bot, I apologize if you need to do something on your end to resync with my commits. |
gbiggs
reviewed
Feb 19, 2022
This is an initial cleanup attempt of the README.md file. All non-code lines have been wrapped to an 80 column width, and some markdown was cleaned up. Further work is needed. Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Numerous fenced code blocks did not have a [info string](https://github.github.com/gfm/#info-string), which meant that the enclosed code block wouldn't be rendered correctly. As it turned out, all of these were intended to be run in a bash shell, so I added that as their info strings. Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
…iables. The scripts weren't directly executable before, requiring manual substitution of various 'variables'. This was unfortunate as Github makes copying and pasting code blocks simple and straightforward. The changes in this commit make it possible to copy/paste each example into it's own shell, which should make it slightly easier for new users to start using the bridge. Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
@gbiggs commented at #342 (comment) that files in ROS2 are intentionally not wrapped to make handling diffs in PRs easier. I've copied in the relevant original lines to unwrap the lines I wrapped earlier. Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Accepted suggestion from @gbiggs Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Co-authored-by: Geoffrey Biggs <gbiggs@killbots.net> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
…details (#346) * The service name might provide more debug information than host:port details Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
Changes due to suggestions from @gbiggs in the discussion of [PR 342](#342 (comment)) Signed-off-by: Cem Karan <cem.f.karan.civ@army.mil>
|
OK, I modified 'galactic' -> 'rolling'. |
gbiggs
approved these changes
Mar 24, 2022
|
Thanks for the contribution! |
|
You're welcome! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I noticed that the README.md file had a number of minor issues that meant that it wasn't as clear as it could be. This PR clears them up.
Issues
bashas the info string of every fenced code block. This makes Github render the blocks correctly, and makes copying simpler.ROS1_INSTALL_PATH, andROS2_INSTALL_PATH. They exist to make it simple to run the scripts regardless of which versions of ROS 1 and 2 are currently in use. Instructions on how to set them are given within the README.md