New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add help for users #12

Open

1 of 4 tasks

augustohp opened this issue Feb 1, 2016 · 0 comments

Labels

easy pick enhancement

Milestone

Owner

augustohp commented Feb 1, 2016 •

edited

Loading

Provide some help through:

Display short help if no arguments are given.
Short format through -h option.
Man page.
Long format though --help (same as man git-pair).

What to put in the man page

Every command format available.
Why we don't change the email.
From where we retrieve the user name.
How to change the name of the command to avoid conflict with similar tools (some are bundled with other stuff).
How to update to newer versions.
Exit codes.

The text was updated successfully, but these errors were encountered:

augustohp added enhancement easy pick labels

augustohp changed the title ~~Add man page~~ Add help for users

augustohp modified the milestone: 1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment