Skip to content

Commit

Permalink
Include the command line usage example in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ironsmile committed Nov 8, 2017
1 parent 6e49c03 commit 1274686
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,17 @@ pip install -r requirements.txt

## Usage

Run the executable script `./pic_to_html`.
Run the executable script `./pic_to_html`. This would start the GUI.

Alternatively you can use the converter in the command line directly:

```bash
python src/classes/img_to_html.py input.jpg output.html \
--chars-width 150 \
--font-size 10
```

See `--help` for more options.

## Thanks to

Expand Down

0 comments on commit 1274686

Please sign in to comment.