Skip to content

Commit

Permalink
Update installation readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nemanja-m committed Sep 10, 2017
1 parent 286159e commit 55c9e06
Showing 1 changed file with 13 additions and 28 deletions.
41 changes: 13 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,28 @@
# About
# gaps

A Genetic Algorithm-Based Solver for Jigsaw Puzzles :cyclone:
Automatic Genetic Algorithm-Based Solver for Jigsaw Puzzles.

# Usage
<p align="center">
<img src="images/lena.gif" alt="demo" />
</p>

Requirements:
# Installation

- `python 2.6+`
- `numpy`
- `scipy`

Install with:

``` bash
git clone https://github.com/nemanja-m/genetic-jigsaw-solver.git
cd genetic-jigsaw-solver/
pip install -e .
```

Create puzzle from image:
Clone repo:

``` bash
create_puzzle <image> [--piece-size] [--destination]
git clone https://github.com/nemanja-m/gaps.git
cd gaps
```

Run solver:
Install requirements:

``` bash
solve [--image] [--generations] [--population] [--size] [--verbose]
pip install -r requirements.txt
```

i.e.
Install project in editable mode:

``` bash
create_puzzle images/lena.jpg --piece-size=32 --destination=puzzle.jpg

# => Puzzle output to 'puzzle.jpg'

solve --image=puzzle.jpg --size=32 --generations=30 --population=300 --verbose=True

# => Solver started
pip install -e .
```

0 comments on commit 55c9e06

Please sign in to comment.