Skip to content

Commit

Permalink
Release v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
kelvindecosta committed Nov 1, 2019
1 parent 991edd2 commit 4682d3a
Show file tree
Hide file tree
Showing 22 changed files with 4 additions and 68 deletions.
70 changes: 3 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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} ...
Expand All @@ -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

Expand Down
Binary file added assets/docs/ascii/charset0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/ascii/charset1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/ascii/color.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/ascii/example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/ascii/negative.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/braille/example.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/braille/threshold128.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/braille/threshold64.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/color/ascii.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/color/braille.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/color/example.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case01.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case02.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case03.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case07.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case08.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case09.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case10.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/case11.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/size/example.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 4682d3a

Please sign in to comment.