Mercurial > public > maze-solver

changeset 16:d85066c2de4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add images to readme
author Dennis C. M. <dennis@denniscm.com>
date Wed, 20 Nov 2024 08:46:42 +0000
parents 7514f6678025
children 01e56e44fd86
files .github/1.png .github/2.png README.md
diffstat 3 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
Binary file .github/1.png has changed
Binary file .github/2.png has changed
--- a/README.md	Sun Mar 03 15:29:12 2024 +0000
+++ b/README.md	Wed Nov 20 08:46:42 2024 +0000
@@ -1,6 +1,8 @@
 # maze-solver
 
-A maze solver written in C.
+I recently saw the [Maze solving youtube video](https://www.youtube.com/watch?v=rop0W4QDOUI) from Computerphile and I find it very interesting. So I decided to build my own maze solver program.
+
+It’s a C program that takes a maze PNG and outputs the solution using the [Wall Follower algorithm](https://en.wikipedia.org/wiki/Maze-solving_algorithm)
 
 ## Constraints
 
@@ -18,6 +20,22 @@
 -   Make a folder named `sols`. The script place the solutions here
 -   Run the program `./maze_solver maze1.png`
 
+### Input
+
+![alt text](.github/1.png)
+
+```bash
+$ ./maze_solver maze.png
+Filename: maze.png
+Width: 101
+Height: 101
+Algorithm duration: 0.000121 seconds
+```
+
+### Output
+
+![alt text](.github/2.png)
+
 ## Note
 
 You can use this [website](https://keesiemeijer.github.io/maze-generator/) to generate mazes