Skip to content

Commit 9794cc7

Browse files
authored
Update README.md
1 parent 968bbe2 commit 9794cc7

File tree

1 file changed

+110
-7
lines changed

1 file changed

+110
-7
lines changed

README.md

Lines changed: 110 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,113 @@
1-
# Algorithm Visualiser
1+
# Algorithm Visualizer
22

3-
Initialised with React + Vite.
4-
Providing visual representation for common algorithms found in Computer Science for students / learning.
3+
Welcome to the **Algorithm Visualizer** project! This tool is designed to provide visual representations of various common algorithms in Computer Science, making it easier for students and learners to understand and interact with these fundamental concepts.
54

6-
Currently implemented algorithms:
7-
- Bubble Sort
8-
- Quick Sort
5+
### Initialised with React + Vite
6+
The project is built using [React](https://reactjs.org/) and [Vite](https://vitejs.dev/), ensuring a fast and responsive user experience.
97

10-
### Hosted on GitHub Pages at: https://a-georgiou.github.io/Algorithm-Visualiser/
8+
## Features
9+
10+
### Sorting Algorithms
11+
1. **Bubble Sort**: Watch as the simplest sorting algorithm compares and swaps elements to sort the array.
12+
2. **Quick Sort**: See the divide-and-conquer approach in action, partitioning arrays and recursively sorting the partitions.
13+
14+
### Search Algorithms (Coming Soon)
15+
- **Linear Search**
16+
- **Binary Search**
17+
18+
### Pathfinding Algorithms
19+
1. **Dijkstra's Algorithm**: Visualize the shortest path between nodes in a graph, ensuring the most efficient route.
20+
2. **A* Algorithm**: Experience a more advanced pathfinding algorithm that uses heuristics to optimize the search.
21+
3. **Breadth-First Search (BFS)**: Explore the graph level by level.
22+
4. **Depth-First Search (DFS)**: Dive deep into the graph to find a path.
23+
24+
### Maze Generation Algorithms
25+
- **Recursive Division**
26+
- **Randomized Prim's Algorithm**
27+
- **Randomized Kruskal's Algorithm**
28+
29+
### Graph Algorithms (Coming Soon)
30+
- **Minimum Spanning Tree (Prim's and Kruskal's)**
31+
- **Topological Sort**
32+
33+
## Getting Started
34+
35+
To get a local copy up and running, follow these steps:
36+
37+
### Prerequisites
38+
- [Node.js](https://nodejs.org/) (Version 14.x or later)
39+
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
40+
41+
### Installation
42+
1. Clone the repo:
43+
```sh
44+
git clone https://github.com/a-georgiou/Algorithm-Visualiser.git
45+
```
46+
2. Navigate to the project directory:
47+
```sh
48+
cd Algorithm-Visualiser
49+
```
50+
3. Install dependencies:
51+
```sh
52+
npm install
53+
```
54+
or
55+
```sh
56+
yarn install
57+
```
58+
59+
### Running the Project
60+
1. Start the development server:
61+
```sh
62+
npm run dev
63+
```
64+
or
65+
```sh
66+
yarn dev
67+
```
68+
2. Open your browser and navigate to `http://localhost:3000`
69+
70+
### Building for Production
71+
1. Build the project:
72+
```sh
73+
npm run build
74+
```
75+
or
76+
```sh
77+
yarn build
78+
```
79+
2. Serve the build output:
80+
```sh
81+
npm run serve
82+
```
83+
or
84+
```sh
85+
yarn serve
86+
```
87+
88+
## Usage
89+
90+
Navigate through the UI to select different algorithms. Adjust parameters as needed and watch the visual representation update in real-time.
91+
92+
## Contributing
93+
94+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
95+
96+
1. Fork the Project
97+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
98+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
99+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
100+
5. Open a Pull Request
101+
102+
## License
103+
104+
Distributed under the MIT License. See `LICENSE` for more information.
105+
106+
## Contact
107+
108+
Andrew Georgiou - Email: [email protected] LinkedIn
109+
110+
Project Link: [https://github.com/a-georgiou/Algorithm-Visualiser](https://github.com/a-georgiou/Algorithm-Visualiser)
111+
112+
### Hosted on GitHub Pages
113+
Check out the live version of the project [here](https://a-georgiou.github.io/Algorithm-Visualiser/).

0 commit comments

Comments
 (0)