Improved readme instructions #15
Merged
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
Signed-off-by: ahcorde <ahcorde@gmail.com>
koonpeng
approved these changes
Mar 1, 2022
README.md
Outdated
| @@ -4,13 +4,14 @@ | |||
| - This repository is under development, you might find compilation errors, | |||
| malfunctions or some undocumented features. | |||
| - This code will only run on Linux (for now). | |||
| - You should [install Ignition Fortress](https://ignitionrobotics.org/docs/fortress) (from source or debs). | |||
| - You should [install Ignition Fortress](https://ignitionrobotics.org/docs/fortress) (from source). | |||
|
|
|||
| **Fatures**: | |||
There was a problem hiding this comment.
Suggested change
| **Fatures**: | |
| **Features**: |
|
|
||
| ```bash | ||
| source ~/turtlebot3_ws/install/setup.bash | ||
| export TURTLEBOT3_MODEL=waffle ros2 launch turtlebot3_ignition ignition.launch.py |
There was a problem hiding this comment.
I think needs to run in a separate terminal without the ignition-omniverse workspace sourced else the pre cxx11 libraries will cause undefined behaviors, might want to add a note regarding this. Same for line 45 with
ign gazebo v -4 shapes.sdf
Signed-off-by: ahcorde <ahcorde@gmail.com>
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.
Signed-off-by: ahcorde ahcorde@gmail.com
🎉 New feature
Summary
Improved readme instructions
Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.