diff DOCS.md @ 13:f05cad159c7b

Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 18:08:52 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DOCS.md	Fri Aug 11 18:08:52 2023 +0000
@@ -0,0 +1,28 @@
+
+# Table of Contents
+
+1.  [Constraints](#org007cf9f)
+2.  [Usage](#org77279b7)
+
+
+<a id="org007cf9f"></a>
+
+# Constraints
+
+-   Only PNG files
+-   Mazes should be square
+-   Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)`
+-   Walls and path should be `1px` width
+-   The starting point must be at `(x: 0, y: 1)`
+-   The ending point should be at `(x: width, y: height - 1)`
+
+
+<a id="org77279b7"></a>
+
+# Usage
+
+-   Build executable
+-   Make a folder named `mazes` and place your mazes there
+-   Make a folder named `sols`. The script place the solutions here
+-   Run the program `./maze_solver maze1.png`
+