Minor updates to README file in the hello_world_plugin example #892
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: Ian Chen <[email protected]>
mjcarroll
reviewed
Sep 1, 2023
| @@ -36,8 +36,9 @@ Now you can run `gz sim` with the name of the resultant library file (without th | |||
| or the file extension, i.e., libHelloWorldPlugin.so -> HelloWorldPlugin): | |||
|
|
|||
| ~~~ | |||
| gz sim --render-engine HelloWorldPlugin | |||
| gz sim -v 4 --render-engine HelloWorldPlugin empty.sdf | |||
There was a problem hiding this comment.
Is verbose needed here for the hello world example?
There was a problem hiding this comment.
not really, I removed it in 4145113. Originally added so that user can check console output to make sure the plugin is loaded but just realized it should still print out an obvious red error msg if plugin is not found without the -v 4 arg.
Signed-off-by: Ian Chen <[email protected]>
Codecov Report
@@ Coverage Diff @@
## gz-rendering7 #892 +/- ##
==============================================
Coverage 77.23% 77.23%
==============================================
Files 170 170
Lines 14738 14738
==============================================
Hits 11383 11383
Misses 3355 3355 |
ahcorde
approved these changes
Sep 6, 2023
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.
🦟 Bug fix
Summary
Updated instructions to launch gz sim with an empty world otherwise the quick start menu will pop up if no world is specified.
Also added info on what to check when the gui comes up in order to verify that the plugin is successfully loaded.
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.