diff --git a/README.md b/README.md index 4a6e931..73df946 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ pip install image-to-text-art ## Usage +With the `-h` flag, the program outputs usage information. + ``` usage: img2txt [-h] {config,art} ... @@ -24,73 +26,7 @@ optional arguments: -h, --help show this help message and exit ``` -* `art` - - ``` - usage: img2txt art [-h] {ascii,braille} ... - - positional arguments: - {ascii,braille} - ascii apply ASCII - braille apply Braille - - optional arguments: - -h, --help show this help message and exit - ``` - - * `ascii` - - ``` - usage: img2txt art ascii [-h] [-c] [-W [width]] [-H [height]] [-o {ansi,html}] - [-f OUTPUT_FILE] [-q] [-s {0,1}] [-n] - image - - positional arguments: - image path to image - - optional arguments: - -h, --help show this help message and exit - -c, --color keep color - -W [width], --width [width] - width of output in characters, flags to fit terminal - -H [height], --height [height] - height of output in characters, flags to fit terminal - -o {ansi,html}, --output-type {ansi,html} - type of output - -f OUTPUT_FILE, --output-file OUTPUT_FILE - path to output file - -q, --quiet disable console output - -s {0,1}, --charset {0,1} - choice of charset (options available in config) - -n, --negative reverse grayscale - ``` - - * `braille` - - ``` - usage: img2txt art braille [-h] [-c] [-W [width]] [-H [height]] - [-o {ansi,html}] [-f OUTPUT_FILE] [-q] - [-t threshold] - image - - positional arguments: - image path to image - - optional arguments: - -h, --help show this help message and exit - -c, --color keep color - -W [width], --width [width] - width of output in characters, flags to fit terminal - -H [height], --height [height] - height of output in characters, flags to fit terminal - -o {ansi,html}, --output-type {ansi,html} - type of output - -f OUTPUT_FILE, --output-file OUTPUT_FILE - path to output file - -q, --quiet disable console output - -t threshold, --threshold threshold - threshold pixel intensity - ``` +For an in depth guide to the functionality of the program, navigate to the [Wiki](https://github.com/kelvindecosta/image-to-text-art/wiki). ## Example diff --git a/assets/docs/ascii/charset0.png b/assets/docs/ascii/charset0.png new file mode 100644 index 0000000..77b5b97 Binary files /dev/null and b/assets/docs/ascii/charset0.png differ diff --git a/assets/docs/ascii/charset1.png b/assets/docs/ascii/charset1.png new file mode 100644 index 0000000..7aae20e Binary files /dev/null and b/assets/docs/ascii/charset1.png differ diff --git a/assets/docs/ascii/color.png b/assets/docs/ascii/color.png new file mode 100644 index 0000000..d7da931 Binary files /dev/null and b/assets/docs/ascii/color.png differ diff --git a/assets/docs/ascii/example.png b/assets/docs/ascii/example.png new file mode 100644 index 0000000..efdc188 Binary files /dev/null and b/assets/docs/ascii/example.png differ diff --git a/assets/docs/ascii/negative.png b/assets/docs/ascii/negative.png new file mode 100644 index 0000000..c18793a Binary files /dev/null and b/assets/docs/ascii/negative.png differ diff --git a/assets/docs/braille/example.jpg b/assets/docs/braille/example.jpg new file mode 100644 index 0000000..c16f275 Binary files /dev/null and b/assets/docs/braille/example.jpg differ diff --git a/assets/docs/braille/threshold128.png b/assets/docs/braille/threshold128.png new file mode 100644 index 0000000..9c906f1 Binary files /dev/null and b/assets/docs/braille/threshold128.png differ diff --git a/assets/docs/braille/threshold64.png b/assets/docs/braille/threshold64.png new file mode 100644 index 0000000..153900d Binary files /dev/null and b/assets/docs/braille/threshold64.png differ diff --git a/assets/docs/color/ascii.png b/assets/docs/color/ascii.png new file mode 100644 index 0000000..2f7ed25 Binary files /dev/null and b/assets/docs/color/ascii.png differ diff --git a/assets/docs/color/braille.png b/assets/docs/color/braille.png new file mode 100644 index 0000000..1db4659 Binary files /dev/null and b/assets/docs/color/braille.png differ diff --git a/assets/docs/color/example.jpg b/assets/docs/color/example.jpg new file mode 100644 index 0000000..c16f275 Binary files /dev/null and b/assets/docs/color/example.jpg differ diff --git a/assets/docs/size/case01.png b/assets/docs/size/case01.png new file mode 100644 index 0000000..d273608 Binary files /dev/null and b/assets/docs/size/case01.png differ diff --git a/assets/docs/size/case02.png b/assets/docs/size/case02.png new file mode 100644 index 0000000..ec627c6 Binary files /dev/null and b/assets/docs/size/case02.png differ diff --git a/assets/docs/size/case03.png b/assets/docs/size/case03.png new file mode 100644 index 0000000..0453a4f Binary files /dev/null and b/assets/docs/size/case03.png differ diff --git a/assets/docs/size/case07.png b/assets/docs/size/case07.png new file mode 100644 index 0000000..c075e9a Binary files /dev/null and b/assets/docs/size/case07.png differ diff --git a/assets/docs/size/case08.png b/assets/docs/size/case08.png new file mode 100644 index 0000000..a5356d5 Binary files /dev/null and b/assets/docs/size/case08.png differ diff --git a/assets/docs/size/case09.png b/assets/docs/size/case09.png new file mode 100644 index 0000000..849e63a Binary files /dev/null and b/assets/docs/size/case09.png differ diff --git a/assets/docs/size/case10.png b/assets/docs/size/case10.png new file mode 100644 index 0000000..6f1b9aa Binary files /dev/null and b/assets/docs/size/case10.png differ diff --git a/assets/docs/size/case11.png b/assets/docs/size/case11.png new file mode 100644 index 0000000..8f9b218 Binary files /dev/null and b/assets/docs/size/case11.png differ diff --git a/assets/docs/size/example.jpg b/assets/docs/size/example.jpg new file mode 100644 index 0000000..d2ea183 Binary files /dev/null and b/assets/docs/size/example.jpg differ diff --git a/setup.py b/setup.py index 9e3eab3..74b0b96 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ setup( name="image-to-text-art", - version="1.0", + version="1.1", description="A command line utility to convert an image to text art.", long_description=long_description, long_description_content_type="text/markdown",