Finish program challenge.

Author: CodeAPretzel

Files/path-data

@@ -0,0 +1,10 @@
+##########
+#.#.##..*#
+#...#..#.#
+#.#.#.##.#
+#.#....#.#
+#.#.##.#.#
+#.#..#...#
+#.##.###.#
+#>#......#
+##########

ai-path-finding.py renamed to Files/path-finding.py

@@ -1,5 +1,16 @@
 """
-Code created by @CodeAPretzel, Pretson G., and ChatGPT (used for math and AI models).
+Code created by @CodeAPretzel, Pretson G., and ChatGPT (for A* algorithm and Manhattan distance in python).
+
+---
+
+Note on "path-data" file:
+
+> = starting point
+. = free spaces
+@ = object/robot navigating the system
+# = obstacles
+* = end goal
+
 """
 
 import math
@@ -26,7 +37,7 @@ def GetNeighbors(position, grid):
     x, y = position
     neighbors = []
     directions = [
-        (0, -1), (0, 1), (-1, 0), (1, 0),  # Cardinal directions
+        (0, -1), (0, 1), (-1, 0), (1, 0),  # Vertical and horizontal directions
         (-1, -1), (1, -1), (-1, 1), (1, 1)  # Diagonal directions
     ]
 
@@ -66,11 +77,11 @@ def DestinationSearch(grid, start, goal):
     return None
 
 def ClearTerminal():
-    # Cross-platform method to clear the terminal
+    # Dual clear terminal
     os.system('cls' if os.name == 'nt' else 'clear')
 
 def DisplayGrid(grid, robotPos=None):
-    # Render the grid in-place
+    # Render the grid
     if robotPos:
         x, y = robotPos
         original = grid[y][x]  # Save the original character

README.md

@@ -1,3 +1,21 @@
-# AI-Pathfinding
+# - Path Finding Algorithms -
 
-Use the data files as input for the python file.
+For the 2024 Missouri Hacks Competition.
+
+<br>
+<br>
+
+### Purpose
+
+Inside of the [Files](https://github.com/CodeAPretzel/Path-Finding-Algorithms/Files), you will find a python file that takes the input of a file map, as displayed in [path-data](https://github.com/CodeAPretzel/Path-Finding-Algorithms/Files).
+
+The object/robot in the program, denoted as "@", navigate the maze in the most efficient manner to reach its end objective which is a "*".
+
+<br>
+<br>
+
+### Credits
+
+[A* Algorithm](https://www.geeksforgeeks.org/a-search-algorithm/)
+[Manhattan Distance](https://www.datacamp.com/tutorial/manhattan-distance)
+[ChatGPT](https://chatgpt.com/)