updates readme with project history and a description

This commit is contained in:
raphael 2021-08-09 09:45:41 +02:00
parent 3ae27ebc13
commit aa0b19bdd5

View File

@ -1,26 +1,34 @@
# MPK.Puzzle
MPK Projekt Puzzle Solver
# Puzzle Solver
Projekt Puzzle Solver
It's designed to parse the images of a jigsaw
puzzle and uses a variety of detectors to match the puzzles pieces together.
The design finds appropriate puzzle pieses by going through layers of detection, eg 'colors', 'histogram', 'sift', 'inward, edge or outward',...
The overlying logic selects the next layer for each piece depending on the current state of the puzzle.
Once it finds a solution to the puzzle that satisfies all layers for each puzzle piece, it stops parsing.
Don't merge branch to master unless you are absolutely, 100% sure it works and you have discussed it with pm!
# How to use Program
- In Master, set cols and rows to size of Puzzle
- Comment or uncomment random Puzzle Generator Line
- Put Pieces .jpg into a 'pieces' dir at same level as git rep dir.
- Name Pieces in dir 0000.jpg, 0001.jpg etc.
# Git intro
0, read github tutorial
1, Clone repository
2, branch master into a team branch (named "Team"+[teamname])
3, work only in this team branch or subbranches
4, don't ever touch the master.
Seriously. don't merge branch to master unless you are absolutely, 100% sure it works and you have discussed it with pm.
# Who wrote this program
This Puzzle Solver was a collaborative project that I worked on with a bunch of people in my masters course. I've linked to all those who have other projects on their github.
- [TabDragon](https://github.com/TabDragon)
- [wlfdm](https://github.com/wlfdm)
- [JRauer](https://github.com/JRauer)
- [JRauer](https://github.com/JRauer)
- [PGotzmann](https://github.com/PGotzmann)
- [l-baumgartner](https://github.com/l-baumgartner)
This is the [original Github page](ttps://github.com/MMRVZ2017/MPK.Puzzlehttps://github.com/MMRVZ2017/MPK.Puzzle) of the project where you can find the list of all collaborators. Note, that this was the first Git project for some of the collaborators, so the person commited does not always qualify the person writing the code.