Mercurial > public > maze-solver

annotate DOCS.md @ 13:f05cad159c7b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 18:08:52 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
1
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
2 # Table of Contents
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
3
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
4 1. [Constraints](#org007cf9f)
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
5 2. [Usage](#org77279b7)
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
6
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
7
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
8 <a id="org007cf9f"></a>
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
9
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
10 # Constraints
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
11
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
12 - Only PNG files
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
13 - Mazes should be square
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
14 - Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)`
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
15 - Walls and path should be `1px` width
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
16 - The starting point must be at `(x: 0, y: 1)`
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
17 - The ending point should be at `(x: width, y: height - 1)`
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
18
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
19
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
20 <a id="org77279b7"></a>
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
21
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
22 # Usage
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
23
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
24 - Build executable
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
25 - Make a folder named `mazes` and place your mazes there
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
26 - Make a folder named `sols`. The script place the solutions here
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
27 - Run the program `./maze_solver maze1.png`
f05cad159c7b Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
28