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 usage examples #19

Open

tomcontileslie opened this issue Oct 8, 2020 · 0 comments

Labels

documentation good first issue

Owner

tomcontileslie commented Oct 8, 2020

Have a part of the README (or the Wiki) just have a list of a load of command line usage examples. Start by saying you should add

alias tc="python3 ~/path/to/ThatChord/thatchord.py"

to your .rc, and then give examples like

tc -h
# get help

tc Cmaj7
# output a Cmaj7 diagram for your default instrument

tc -i guitar -r guitar "D11(b5)"
# punctually change instrument

tc -f text -o print F
# print chord to command line

tc -f text -o print "F:2"
# didn't like the way it suggested playing F, try the second

tc "Cm@4"
# how do I play Cm way up on the frets?

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

tomcontileslie added documentation good first issue labels

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