Skip to content

Commit 8f97332

Browse files
committed
Adds README.md
1 parent 3a6e7a5 commit 8f97332

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# SRTVIZ - A simple sorting algorithm visualizer
2+
![srtviz_logo](./assets/srtviz.png)
3+
![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/tory1103/srtviz/main)
4+
![GitHub issues](https://img.shields.io/github/issues-raw/tory1103/srtviz)
5+
![Version](https://img.shields.io/badge/Version-C%2B%2B17-green)
6+
7+
8+
My goal in this project is a real-time visualizer for sorting algorithms. The implementation of algorithms is self-made, and the visualization is done using SFML. The project is still in development, and I will add more algorithms and features in the future.
9+
10+
## Features
11+
- Real-time visualization of sorting algorithms
12+
- User can choose the algorithm to visualize
13+
- User can choose the size of the array to sort
14+
- Random array generation
15+
16+
## Algorithms
17+
- Bubble sort
18+
- Selection sort
19+
- Insertion sort
20+
- More to come...
21+
22+
## How to use
23+
```bash
24+
# Make sure dependencies are installed
25+
# SMFL: https://www.sfml-dev.org/tutorials/2.5/start-linux.php
26+
27+
# Clone the repository
28+
git clone https://github.com/tory1103/srtviz.git
29+
30+
# Create a build directory
31+
mkdir build
32+
cd build
33+
34+
# Build the project
35+
cmake ..
36+
make
37+
38+
# Run the project
39+
./srtviz
40+
```
41+
42+
## Dependencies
43+
- SFML
44+
- CMake
45+
- Make
46+
- GCC
47+
- Git

assets/srtviz.png

16.7 KB
Loading

0 commit comments

Comments
 (0)