Refactor README examples into a QuickStart #1665
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
shadowspawn
added
the
pending release
shadowspawn
removed
the
pending release
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.
Pull Request
Problem
We have a comprehensive README but would like new users to get a quick idea of what Commander does, whether they like the look of it, and how to start writing code.
Related: #1588
Solution
Write a brief overview of Commander supported by new single-command and multiple command examples.
The single-command example deliberately leaves out the option descriptions to show a minimal program with just the two main option types declared. The example usage shows Commander being strict, with a suggestion as a bonus!
The second example shows features common to a more complete program without going into details: help descriptions, name, version, subcommand, command-argument, default value for an option. The example usage shows the help output which is an important feature.