Mercurial > public > maze-solver

changeset 4:0ce45179d7b0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add documentation
author Dennis <denniscmartin@protonmail.com>
date Sun, 16 Oct 2022 16:46:24 +0200
parents d0e9c4ff404c
children 3d6399799527
files README.md
diffstat 1 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Sun Oct 16 16:25:00 2022 +0200
+++ b/README.md	Sun Oct 16 16:46:24 2022 +0200
@@ -2,7 +2,21 @@
 
 A maze solver written in C.
 
+## Constraints
+- Only PNG files
+- Mazes must be square
+- Walls must be black `rgb(0, 0, 0)` and path white `rgb(255, 255, 255)`
+- Walls and path must be 1 px width
+- The starting point must be at `(x: 0, y: 1)`
+- The ending point must be at `(x: width, y: height - 1)`
+
+## Usage
+
+1. Build executable
+2. Make a folder named `mazes` and place the `png` files there.
+3. Make a folder named `sols`. The script place the solutions here.
+
 ## Resources
 - [Libpng example](http://zarb.org/~gc/html/libpng.html)
 - [Libpng manual](http://www.libpng.org/pub/png/libpng-1.2.5-manual.html)
-- [Inspired by Dr Mike Poung (Computerphile video)](https://www.youtube.com/watch?v=rop0W4QDOUI)
\ No newline at end of file
+- [Inspired by Dr Mike Pound (Computerphile video)](https://www.youtube.com/watch?v=rop0W4QDOUI)
\ No newline at end of file