Skip to content

Commit

Permalink
added build instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaswagner committed Jun 21, 2018
1 parent ca161fc commit 486ecdf
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,27 @@ Muscheln und Schnecken des Museums für Naturkunde Berlin freistellen und neue B
|master | [![Build Status](https://travis-ci.com/snailsnap/mosaic.svg?branch=master)](https://travis-ci.com/snailsnap/mosaic) | [![Build status](https://ci.appveyor.com/api/projects/status/5g1x1yk1wvlohao2/branch/master?svg=true)](https://ci.appveyor.com/project/lukaswagner/mosaic/branch/master) |
|develop | [![Build Status](https://travis-ci.com/snailsnap/mosaic.svg?branch=develop)](https://travis-ci.com/snailsnap/mosaic) | [![Build status](https://ci.appveyor.com/api/projects/status/5g1x1yk1wvlohao2/branch/develop?svg=true)](https://ci.appveyor.com/project/lukaswagner/mosaic/branch/develop) |

## How to Run

- Install Qt
- Clone it
- Initialize submodules (if SmtpClient or JCVoronoi fail to build, you're missing this)
- Run CMake
- Build it
- Place the data folder (containing the snail images, the meta file and the optional descriptions) next to the built executable
- Run it
- If it doesn't work for some reason, check these steps again, and if it still doesn't work create an issue where you tell [Lukas](https://github.com/lukaswagner) to improve the readme.

## Command Line Arguments

- Important
- `-n` or `--maxNumOfMolluscs` - Number of snails to build the mosaic from. A good value is 7500.
- Optional
- `-d` or `--data` - Path to the data folder, if it's not placed directly next to the executable.
- `-c` or `--useCam` - Whether the camera should be used to capture images. Pass `false` to use a file dialog to open an existing image. Default is `true`.
- Unnecessary
- `-o` or `--output` - Output of the processed image. Just for debugging.

## Dependencies

- [Qt](https://www.qt.io/)
Expand Down

0 comments on commit 486ecdf

Please sign in to comment.