Update README.md

README.md

@@ -1 +1,59 @@
-# MazeSolver
+# Maze Solver
+
+A Maze generator & solver using backtracking. This project is written in C++ and SFML.
+
+![Maze Solver Preview (Custom) (2)](https://github.com/RamezzE/MazeSolver/assets/117018553/d085fe87-25e9-4ca6-a95d-1dbff72bda11)
+
+## Table of Contents
+
+- [Features](#features)
+- [Building](#building)
+
+## Features
+
+1. [Maze Generation](#maze-generation)
+2. [Maze Solving](#solving-the-maze)
+3. [Finding all shortest paths](#shortest-paths)
+4. [Resizing](#resize-the-grid)
+5. [Adjusting simulation speed & wall thickness](#adjust-speed-and-wall-thickness)
+6. [Changing start and end positions](#change-start-and-end)
+7. [Manually editing the maze](#editing-the-maze)
+8. [Exporting as an Image](#export-as-png)
+
+#### Maze Generation
+Randomly generate a maze with 1 solution initially as many times as you want.
+
+#### Solving the Maze
+
+Solve the maze with the first solution found.
+
+#### Shortest Paths
+
+Find all the shortest paths in the maze and view them all with side arrows.
+
+#### Resize the Grid
+
+You can resize the grid and regenerate the maze.
+
+#### Adjust Speed and Wall Thickness
+
+You can pause (speed to 0), slow down or speed up the simulation speed at any time.
+You can increase or decrease the wall thickness.
+
+#### Change Start and End
+Change start & end positions for the maze.
+
+#### Editing the maze
+Left mouse click toggles the visibility of the top wall of any cell.
+Right mouse click does the same for the right wall
+
+#### Export as PNG
+Export the maze as an image in PNG format.
+
+![Mon Jun 19 190400 2023](https://github.com/RamezzE/MazeSolver/assets/117018553/a701b76e-c15c-40ef-99f9-9f6db6091461)
+![Mon Jun 19 190427 2023](https://github.com/RamezzE/MazeSolver/assets/117018553/d02d0c28-9f72-4678-96fe-52060e51361f)
+![x](https://github.com/RamezzE/MazeSolver/assets/117018553/965935ee-efa2-4729-9d4c-475bf89ab6f1)
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).