Mercurial > public > maze-solver
comparison README.md @ 15:7514f6678025
Add docs to README
| author | Dennis Concepción Martín <dennis@denniscmartin.com> |
|---|---|
| date | Sun, 03 Mar 2024 15:29:12 +0000 |
| parents | 06050949285b |
| children | d85066c2de4a |
comparison
equal
deleted
inserted
replaced
| 14:06050949285b | 15:7514f6678025 |
|---|---|
| 1 | |
| 2 # maze-solver | 1 # maze-solver |
| 3 | 2 |
| 4 A maze solver written in C. | 3 A maze solver written in C. |
| 4 | |
| 5 ## Constraints | |
| 6 | |
| 7 - Only PNG files | |
| 8 - Mazes should be square | |
| 9 - Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)` | |
| 10 - Walls and path should be `1px` width | |
| 11 - The starting point must be at `(x: 0, y: 1)` | |
| 12 - The ending point should be at `(x: width, y: height - 1)` | |
| 13 | |
| 14 ## Usage | |
| 15 | |
| 16 - Build executable | |
| 17 - Make a folder named `mazes` and place your mazes there | |
| 18 - Make a folder named `sols`. The script place the solutions here | |
| 19 - Run the program `./maze_solver maze1.png` | |
| 20 | |
| 21 ## Note | |
| 22 | |
| 23 You can use this [website](https://keesiemeijer.github.io/maze-generator/) to generate mazes |