Skip to content

Commit c3efbfa

Browse files
Update README.md
updated reamde.md
1 parent df3c83a commit c3efbfa

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# Pathfinfing Algorithms
2-
3-
This project provides simple implementations of several graph traversal and pathfinding algorithms in Python. The algorithms included are designed to find the shortest path between two points on a graph or grid.
1+
# Pathfinding Algorithms
42

5-
Algorithms Implemented:
6-
1. Depth First Search (DFS)
7-
2. Dijkstra's Algorithm
8-
3. Bidirectional Search
9-
4. A* Algorithm
10-
5. Jump Point Search (JPS)
11-
6. Theta* Algorithm
3+
This project provides simple implementations of several graph traversal and pathfinding algorithms in Python. These algorithms are designed to find the shortest path between two points on a graph or grid.
124

13-
Features:
14-
GUI for visualizing live search
15-
Customizable path and start/end points
16-
Customizable Grid Size
5+
## Algorithms Implemented
6+
1. **Depth First Search (DFS)**
7+
2. **Dijkstra's Algorithm**
8+
3. **Bidirectional Search**
9+
4. **A star Algorithm**
10+
5. **Jump Point Search (JPS)**
11+
6. **Theta star Algorithm**
1712

18-
Prerequisites
19-
Python 3.x
20-
Required libraries:
21-
pygame
22-
You can install the required libraries using the following command:
23-
pip install -r requirements.txt
13+
## Features
14+
- GUI for visualizing live search
15+
- Customizable start and end points
16+
- Adjustable grid size
2417

25-
Packaging the Project with PyInstaller
26-
To package this project into a standalone executable, you can use PyInstaller. Follow the instructions below to create the executable:
27-
pyinstaller --noconfirm --onefile --windowed --icon "C:\Users\muahm\Documents\Programming Projects\Python programs\Pathfinfing-Algorithms\src\assets\images\icon.ico" --name "Pathfinding Algorithms" --add-data "C:\Users\muahm\Documents\Programming Projects\Python programs\Pathfinfing-Algorithms\src;src/" --add-data "C:\Users\muahm\Documents\Programming Projects\Python programs\Pathfinfing-Algorithms\src\assets;assets/" --hidden-import "pygame" --hidden-import "qeue" "C:\Users\muahm\Documents\Programming Projects\Python programs\Pathfinfing-Algorithms\src\__main__.py"
18+
## Prerequisites
19+
- **Python 3.x**
20+
21+
### Required Libraries
22+
- `pygame`
23+
24+
You can install the required libraries using the following command:
25+
26+
```bash
27+
pip install -r requirements.txt

0 commit comments

Comments
 (0)