Mercurial > public > maze-solver

annotate README.md @ 15:7514f6678025

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
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.
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
4
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
5 ## Constraints
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
6
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
7 - Only PNG files
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
8 - Mazes should be square
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
9 - Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
10 - Walls and path should be `1px` width
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
11 - The starting point must be at `(x: 0, y: 1)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
12 - The ending point should be at `(x: width, y: height - 1)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
13
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
14 ## Usage
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
16 - Build executable
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
17 - Make a folder named `mazes` and place your mazes there
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
18 - Make a folder named `sols`. The script place the solutions here
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
19 - Run the program `./maze_solver maze1.png`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
20
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
21 ## Note
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
22
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
23 You can use this [website](https://keesiemeijer.github.io/maze-generator/) to generate mazes