Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
akademi4eg committed Jan 13, 2019
1 parent 615be9a commit 939c233
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Convert image to cross patterns

Setup:
```
pip3 install -r requirements.txt
```

Script does the following steps:
1. Tune image contrast.
2. Reduce number of image colors.
3. Map remaining color to closest flosses.
4. Render and save results.

Script arguments:
```
usage: main.py [-h] [--image IMAGE] [--enhance ENHANCE] [--width WIDTH]
[--max_colors MAX_COLORS] [--show SHOW]
Expand All @@ -12,3 +25,9 @@ optional arguments:
Max number of flosses to use.
--show SHOW Whether to show result in separate window.
```

Example image:
![input image](data/image.jpg)

Result of running `python3 ./main.py`:
![scheme image](data/scheme.jpg)

0 comments on commit 939c233

Please sign in to comment.