From 38e751ebbc19c1142227259e80920b724ed2e20e Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Sun, 18 Feb 2024 10:51:20 +0000 Subject: [PATCH] add screenshots --- README.md | 6 ++++++ assets/images/launch_application.png | 3 +++ assets/images/option_selection.png | 3 +++ assets/images/running_the_simulation.png | 3 +++ 4 files changed, 15 insertions(+) create mode 100644 assets/images/launch_application.png create mode 100644 assets/images/option_selection.png create mode 100644 assets/images/running_the_simulation.png diff --git a/README.md b/README.md index d795a04..9388510 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ python3 main.py You should now see the Maze Solver window on your screen. +![Launching the application](assets/images/launch_application.png) + Generate a new maze by clicking on the `Generate maze` button and watch the application generate the maze. Once the maze is generated choose which searching algorithm you want to see solve the maze. @@ -55,11 +57,15 @@ Next choose if you want to enable randomness to the algorithm with the `Enable r Randomness is applied when the solver stands before a fork in its path and has to choose from a number of possible directions. With randomness enabled it will randomly choose the next direction and with it disabled the next direction is chosen from something very similar to an ordered list. +![Selecting options](assets/images/option_selection.png) + Once you're happy with the options, click on the `Solve the maze` button to start the simulation. As the solver traverses through the maze, it leaves a red path so that you can keep track of its progress. When the solver reaches a dead-end it backtracks until it can choose a new path to traverse. When it backtracks it leaves behind a grey trail. +![Running the simulation](assets/images/running_the_simulation.png) + After the solver solves the maze (or fails to do so) you can run the simulation again on the same maze with by pressing the Solve the maze button. Try running choosing a different algorithm or toggle between randomness before running the simulation again. You can also generate a new maze by clicking the `Generate maze` button again. diff --git a/assets/images/launch_application.png b/assets/images/launch_application.png new file mode 100644 index 0000000..9e7f5b2 --- /dev/null +++ b/assets/images/launch_application.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5d51c1d2b892aec0984eed3392c81335781ed9cf680e32ac72cd3ea75e68a27 +size 19548 diff --git a/assets/images/option_selection.png b/assets/images/option_selection.png new file mode 100644 index 0000000..c0ded8e --- /dev/null +++ b/assets/images/option_selection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07343adafa60fa3f1e5f3c991eaaf37c58f3e768c950f30e048158e13fbaa30f +size 21964 diff --git a/assets/images/running_the_simulation.png b/assets/images/running_the_simulation.png new file mode 100644 index 0000000..f4e36b2 --- /dev/null +++ b/assets/images/running_the_simulation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48ce944a36fd080e4373c20fc09f2e1b014e3a0409883fd73f5a641dfca86eeb +size 22443