diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff3e2d6 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Sago's Multi Scrambler Puzzle II + +A puzzle game featuring different kind of puzzles. + +## Screenshot + +![Scrambled puzzle](https://files.poulsander.com/~poul19/public_files/sago_multi_scrambler_puzzle2_2022-05-08.png) + +## Building + +``` +cmake . +make +``` + +## Run + +Currently an image must be given on the command line like so: +``` +./sago_multi_scrambler_puzzle2 [JPG_OR_PNG_IMAGE] +``` + + +``` +./sago_multi_scrambler_puzzle2 data/collections/fairy_tales/The\ Three\ Bears\ \(1918\).jpg +```