Make command line help easier to understand #968
Merged
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.
Description
A common complaint, both here at github as well as social channels like Discord, is how to actually run our samples. You need to specify the name of a sample after an argument called
sample
. If you don't do that you get a huge list of all available options starting with an error text that's not easy to understand:Not only is this a lot of text that'll confuse people, but the actual command on how to run a sample is somewhere at the bottom of this.
This PR simplifies all of this, and if you now run the application without a sample or with a sample name that doesn't exist you get a proper help text that's much easier to understand:
This message also tells people about the two other important arguments: getting a list of available samples and a list of all available command line arguments.
This should make it much easier to understand how to launch samples for new users.
Fixes #966
Tested on Windows 11 and Ubuntu 22.04 (via WSL2)
General Checklist:
Please ensure the following points are checked:
Note: The Samples CI runs a number of checks including: