diff --git a/Makefile b/Makefile index 91b92ed..8c9a913 100644 --- a/Makefile +++ b/Makefile @@ -68,7 +68,7 @@ diff-docs: svg-docs: lolcat -F .5 -S 9 -f assets/logo.txt | yartsu -o assets/logo.svg - yartsu -o assets/yartsu.svg -t "yartsu --help" -- yartsu -h + yartsu -o assets/help.svg -t "yartsu --help" -- yartsu -h demo-docs: python -c \ diff --git a/README.md b/README.md index 624d6c2..860eec0 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Otherwise you can download an extract manually to somewhere on your path. ## Usage -
Logo
+
Logo
Getting a properly formatted output from a terminal screenshot is challenging. diff --git a/assets/demo.svg b/assets/demo.svg index c01edc2..7335bc2 100644 --- a/assets/demo.svg +++ b/assets/demo.svg @@ -1,4 +1,4 @@ - + + @@ -45,14 +49,15 @@ - yartsu - + + yartsu + - + diff --git a/assets/help.svg b/assets/help.svg new file mode 100644 index 0000000..e605068 --- /dev/null +++ b/assets/help.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + yartsu --help + + + + + + + + + + usage: + +convert terminal output to svg + +    `ls --color=always | yartsu [options]` +OR +    `yartsu [options] -- ls --color` +OR +    `ls --color=always > ls.txt; yartsu -i ls.txt` + +options: +-h--help           show this help message and exit +-V--version        show program's version number and exit +-i--input INPUT    input file [default: stdin] +-o--output OUTPUT  output svg file [default: capture.svg] +-t--title TITLE    title for terminal window +-w--width WIDTH    width of svg +--theme THEME        theme to use for highlighting [default: cat-mocha] +--list-themes        list available themes + + + + diff --git a/assets/logo.svg b/assets/logo.svg index 8e070c1..29b27b1 100644 --- a/assets/logo.svg +++ b/assets/logo.svg @@ -1,4 +1,4 @@ - + + @@ -116,14 +120,15 @@ - yartsu - + + yartsu + - + ____ diff --git a/assets/themes/cat-frappe.svg b/assets/themes/cat-frappe.svg index 1fddde6..2be8e2e 100644 --- a/assets/themes/cat-frappe.svg +++ b/assets/themes/cat-frappe.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme cat-frappe --demo - + + yartsu --theme cat-frappe --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/cat-latte.svg b/assets/themes/cat-latte.svg index d478363..f805ab8 100644 --- a/assets/themes/cat-latte.svg +++ b/assets/themes/cat-latte.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme cat-latte --demo - + + yartsu --theme cat-latte --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/cat-macchiato.svg b/assets/themes/cat-macchiato.svg index 117c6b1..a680854 100644 --- a/assets/themes/cat-macchiato.svg +++ b/assets/themes/cat-macchiato.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme cat-macchiato --demo - + + yartsu --theme cat-macchiato --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/cat-mocha.svg b/assets/themes/cat-mocha.svg index dedb166..23178cb 100644 --- a/assets/themes/cat-mocha.svg +++ b/assets/themes/cat-mocha.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme cat-mocha --demo - + + yartsu --theme cat-mocha --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/dimmed_monokai.svg b/assets/themes/dimmed_monokai.svg index 9d14ee1..39ee859 100644 --- a/assets/themes/dimmed_monokai.svg +++ b/assets/themes/dimmed_monokai.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme dimmed_monokai --demo - + + yartsu --theme dimmed_monokai --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/dracula.svg b/assets/themes/dracula.svg index abfa53e..4263e6c 100644 --- a/assets/themes/dracula.svg +++ b/assets/themes/dracula.svg @@ -1,4 +1,4 @@ - + + @@ -618,14 +622,15 @@ - yartsu --theme dracula --demo - + + yartsu --theme dracula --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/gruvbox-dark.svg b/assets/themes/gruvbox-dark.svg index 2885ec2..98bbbe7 100644 --- a/assets/themes/gruvbox-dark.svg +++ b/assets/themes/gruvbox-dark.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme gruvbox-dark --demo - + + yartsu --theme gruvbox-dark --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/gruvbox-light.svg b/assets/themes/gruvbox-light.svg index 0246bc8..c9ba8ff 100644 --- a/assets/themes/gruvbox-light.svg +++ b/assets/themes/gruvbox-light.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme gruvbox-light --demo - + + yartsu --theme gruvbox-light --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/monokai.svg b/assets/themes/monokai.svg index 0713786..2c918bb 100644 --- a/assets/themes/monokai.svg +++ b/assets/themes/monokai.svg @@ -1,4 +1,4 @@ - + + @@ -616,14 +620,15 @@ - yartsu --theme monokai --demo - + + yartsu --theme monokai --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/night-owlish.svg b/assets/themes/night-owlish.svg index 3a85970..f65ff76 100644 --- a/assets/themes/night-owlish.svg +++ b/assets/themes/night-owlish.svg @@ -1,4 +1,4 @@ - + + @@ -615,14 +619,15 @@ - yartsu --theme night-owlish --demo - + + yartsu --theme night-owlish --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/nord.svg b/assets/themes/nord.svg index f7b61d6..a872a2b 100644 --- a/assets/themes/nord.svg +++ b/assets/themes/nord.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme nord --demo - + + yartsu --theme nord --demo + - +                                                      Rich features                                                       diff --git a/assets/themes/rich-default.svg b/assets/themes/rich-default.svg index 213c9ca..d1703f9 100644 --- a/assets/themes/rich-default.svg +++ b/assets/themes/rich-default.svg @@ -1,4 +1,4 @@ - + + @@ -619,14 +623,15 @@ - yartsu --theme rich-default --demo - + + yartsu --theme rich-default --demo + - +                                                      Rich features                                                       diff --git a/assets/yartsu.svg b/assets/yartsu.svg deleted file mode 100644 index 4e150d4..0000000 --- a/assets/yartsu.svg +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - yartsu --help - - - - - - - - - - usage: - -    ls --color=always | yartsu [options] -OR -    yartsu [options] -- ls --color -OR -    ls --color=always > ls.txt; yartsu -i ls.txt - -convert terminal output to svg - -options: --h--help           show this help message and exit --V--version        show program's version number and exit --i--input INPUT    input file [default: stdin] --o--output OUTPUT  output svg file [default: capture.svg] --t--title TITLE    title for terminal window --w--width WIDTH    width of svg ---theme THEME        theme to use for highlighting [default: cat-mocha] ---list-themes        list available themes - - - -