Skip to content

Commit 9463cbe

Browse files
authored
Merge pull request #1 from SteponasK/branch_update_Readme
Fixed ReadMe file
2 parents 115ac56 + 7285f5a commit 9463cbe

File tree

4 files changed

+69
-3
lines changed

4 files changed

+69
-3
lines changed

LICENSE renamed to LICENSE.txt

File renamed without changes.

README.md

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,70 @@
1-
# Sorting_Algorithms
1+
# Sorting Algorithm visualisation
2+
![menu_picture](ReadMe_img/menu.png)
3+
Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works.
4+
## Available algorithms
5+
1. Bubble sort
6+
1. Shaker (Coctail) Sort
7+
1. Selection Sort
8+
1. Double selection sort
9+
1. Insertion Sort
10+
11+
## Features
12+
![Sorting_Algorithm_Gif](ReadMe_img/sorting_algorithm.gif)
13+
- 5 Different Sorting Algorithms
14+
- Change number of Bars to be sorted
15+
- Change FrameRate (FPS) cap
16+
- Explanation, of how each sorting algorithm works.
17+
18+
## Prerequisites
19+
You need to have [CMake]((https://cmake.org/download/)) or [SFML](https://www.sfml-dev.org/download.php) installed.
20+
21+
22+
## Installation
23+
24+
#### If you have CMake installed:
25+
26+
Open your Command Prompt or Terminal
27+
28+
For a single-configuration generator (typically the case on Linux and macOS):
29+
30+
-
31+
```
32+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
33+
cmake --build build
34+
```
35+
36+
For a multi-configuration generator (typically the case on Windows):
37+
38+
-
39+
```
40+
cmake -S . -B build
41+
cmake --build build --config Release
42+
```
43+
44+
45+
#### Compiling it yourself with SFML:
46+
1. Clone this repository
47+
```
48+
git clone https://github.com/SteponasK/Sorting_Algorithms_SFML
49+
```
50+
1. Configure your project, using online [guide](https://www.sfml-dev.org/tutorials/2.6/start-vc.php) or a youtube [ video](https://www.youtube.com/watch?v=neIoDQ71yb0).
51+
52+
1. Compile all the files using Visual Studio or the IDE of your choice.
53+
## Built With
54+
55+
* [SFML](https://www.sfml-dev.org/) - Software Development Library
56+
* [C++](https://cplusplus.com/) Programming Language
57+
58+
## Contributing
59+
60+
Currently, contributing to the project is not available, as the project was created for me to learn SFML, C++ and Sorting Algorithm theory.
61+
Howerer feel free to fork this project, and experiment with your own modifications!
62+
63+
## Authors
64+
65+
* **SteponasK** - *Initial work*
66+
67+
## License
68+
69+
This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the [LICENSE](LICENSE.txt) file for details
270
3-
CMakeSFMLProject.cpp is main file.
4-
Sorting Algorithm application made in SFML

ReadMe_img/menu.png

166 KB
Loading

ReadMe_img/sorting_algorithm.gif

5.04 MB
Loading

0 commit comments

Comments
 (0)