Mercurial > public > maze-solver

annotate README.md @ 9:22cf01362b45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
modify readme
author Dennis <denniscmartin@protonmail.com>
date Sun, 30 Oct 2022 17:03:24 +0100
parents deeb54b231aa
children e3addd013d36
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
1 # maze-solver
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
2
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
3 A maze solver written in C.
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
4
4
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
5 ## Constraints
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
6 - Only PNG files
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
7 - Mazes must be square
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
8 - Walls must be black `rgb(0, 0, 0)` and path white `rgb(255, 255, 255)`
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
9 - Walls and path must be 1 px width
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
10 - The starting point must be at `(x: 0, y: 1)`
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
11 - The ending point must be at `(x: width, y: height - 1)`
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
12
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
13 ## Usage
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
14
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
15 1. Build executable
9
22cf01362b45 modify readme
Dennis <denniscmartin@protonmail.com>
parents: 8
diff changeset
16 2. Make a folder names `mazes` and place your mazes there.
22cf01362b45 modify readme
Dennis <denniscmartin@protonmail.com>
parents: 8
diff changeset
17 3. Make a folder named `sols`. The script place the solutions here.
4
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
18
8
deeb54b231aa refactor code
Dennis <denniscmartin@protonmail.com>
parents: 7
diff changeset
19 ![maze](.github/resources/maze.png)
deeb54b231aa refactor code
Dennis <denniscmartin@protonmail.com>
parents: 7
diff changeset
20 ![solution](.github/resources/sol.png)
7
a9dd80a69887 add images
Dennis <denniscmartin@protonmail.com>
parents: 5
diff changeset
21
1
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
22 ## Resources
5
3d6399799527 add maze generator link
Dennis <denniscmartin@protonmail.com>
parents: 4
diff changeset
23 - [Maze generator](https://keesiemeijer.github.io/maze-generator/#generate)
1
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
24 - [Libpng example](http://zarb.org/~gc/html/libpng.html)
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
25 - [Libpng manual](http://www.libpng.org/pub/png/libpng-1.2.5-manual.html)
4
0ce45179d7b0 add documentation
Dennis <denniscmartin@protonmail.com>
parents: 1
diff changeset
26 - [Inspired by Dr Mike Pound (Computerphile video)](https://www.youtube.com/watch?v=rop0W4QDOUI)