robertdfrench / git-pr

Pull requests without Git(Hub|Lab)
GNU General Public License v3.0
0 stars 1 forks source link

Write a tutorial! #32

Open robertdfrench opened 2 years ago

robertdfrench commented 2 years ago

We are doing a moderately good job documenting the code, and we have plans (#29) to write reference documentation for each individual command, but nothing beats a good overall tutorial with usage examples.

robertdfrench commented 2 years ago

This is sortof addressed in #58, since the man page has an EXAMPLES section, but there really should be a more extensive, preferably web-based tutorial. Likely in markdown, possibly in the top-level README.md