diff --git a/README.md b/README.md index b76a49c..43195bf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ -![screenshot](https://github.com/tat3r/tdfiglet/blob/master/screenshot.png?raw=true) # tdfiglet -Because your ascii sucks. +Because your figlet ascii sucks. + +![screenshot](https://git.trollforge.org/tdfiglet/plain/screenshot.png) ## Installation -run make and copy tdfiglet wherever you want. +``` +make +sudo make install +``` ## Usage -run tdfiglet -h for a list of options +If you're just trying to spam irc `tdfiglet -cm yes hello` will suffice. + +``` +usage: tdfiglet [options] -f [font] input + + -f [font] Specify font file used. + -j l|r|c Justify left, right, or center. Default is left. + -w n Set screen width. Default is 80. + -c a|m Color format ANSI or mirc. Default is ANSI. + -e u|a Encode as unicode or ASCII. Default is unicode. + -i Print font details. + -h Print usage. +```