diff --git a/README.md b/README.md index 6956b37..54f3ab1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ -# [Maze](https://cfoulk.github.io/Maze/) · [![Github license](https://img.shields.io/github/license/cfoulk/Maze?style=social)](https://github.com/cfoulk/Maze/blob/main/LICENSE) +

+
+ Maze +
+ Maze +
+

-Maze is a website that visualizes graph pathfinding algorithms. +

+ + Github license + +

+ +

Maze is a website that visualizes graph pathfinding algorithms. Built entirely in Vanilla Javascript, HTML, & CSS

+ +

+ Key Features • + Use Locally • + Contact +

+ +![demonstration](./public/demo.gif) + +## Key Features + +* Visualization of pathfinding algorithms + * Breadth-First Search + * Depth-First Search +* User control of start/end points +* User can control the flow of algorithms with the use of walls(blocking paths) +* Live visual recreations with user input + * Changing walls with change the flow of visited cells + * Move start/end points +* Maze creation presets + * Randomized maze +* Mobile support across browers and platforms +* Responsive layout +* Draggable diagnostic panel + +## Use Locally + +

If you want to mess around with the source code, you can clone this repository and setup your own local http server.

+ +```bash +# Clone this repository +$ git clone https://github.com/cfoulk/Maze + +# enter new repository directory +$ cd Maze + +# open project with a local http server +$ live-server . + +# or with python +$ python3 -m http.server +``` + +## Contact + +**Email:** [charlesfoulk@csus.edu](mailto:charlesfoulk@csus.edu) + +**Github:** [@cfoulk](https://github.com/cfoulk) diff --git a/public/demo.gif b/public/demo.gif new file mode 100644 index 0000000..3f19322 Binary files /dev/null and b/public/demo.gif differ diff --git a/public/demonstration.gif b/public/demonstration.gif new file mode 100644 index 0000000..89e8c64 Binary files /dev/null and b/public/demonstration.gif differ diff --git a/public/largerLogo.png b/public/largerLogo.png new file mode 100644 index 0000000..ece70be Binary files /dev/null and b/public/largerLogo.png differ