From d743124e887a68b470ba7ebafd3734df6dfae7a1 Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Sat, 2 Sep 2023 19:52:42 +0300 Subject: [PATCH 1/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0a40398..ded357f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Sorting Algorithm visualisation ![menu_picture](ReadMe_img/menu.png) + Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works. ## Available algorithms 1. Bubble sort From 5defe5472340639c80d8d817d455e8684e5b56ea Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:56:12 +0300 Subject: [PATCH 2/6] Updated readme --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ded357f..15cb0bb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Sorting Algorithm visualisation +# Sorting Algorithm Visualisation ![menu_picture](ReadMe_img/menu.png) -Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works. +Educational Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works. +__EDUCATIONAL APPLICATION__ ## Available algorithms 1. Bubble sort 1. Shaker (Coctail) Sort @@ -9,18 +10,18 @@ Sorting algorithms visualisation made using SFML and C++, used to learn how a so 1. Double selection sort 1. Insertion Sort -## Features +## 💪 Features ![Sorting_Algorithm_Gif](ReadMe_img/sorting_algorithm.gif) - 5 Different Sorting Algorithms - Change number of Bars to be sorted - Change FrameRate (FPS) cap - Explanation, of how each sorting algorithm works. -## Prerequisites +## 📖 Prerequisites You need to have [CMake]((https://cmake.org/download/)) or [SFML](https://www.sfml-dev.org/download.php) installed. -## Installation +## ⬇️ Installation #### If you have CMake installed: @@ -37,7 +38,7 @@ For a single-configuration generator (typically the case on Linux and macOS): For a multi-configuration generator (typically the case on Windows): - - ``` + ``` bash cmake -S . -B build cmake --build build --config Release ``` @@ -51,17 +52,17 @@ git clone https://github.com/SteponasK/Sorting_Algorithms_SFML 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). 1. Compile all the files using Visual Studio or the IDE of your choice. -## Built With +## 🏗️ Built With * [SFML](https://www.sfml-dev.org/) - Software Development Library * [C++](https://cplusplus.com/) Programming Language -## Contributing +## ✨ Contributing Currently, contributing to the project is not available, as the project was created for me to learn SFML, C++ and Sorting Algorithm theory. Howerer feel free to fork this project, and experiment with your own modifications! -## Authors +## 👑 Authors * **SteponasK** - *Initial work* From 34345f668d5fbfa39392442560f6c0aa85c94004 Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Mon, 1 Apr 2024 17:00:57 +0300 Subject: [PATCH 3/6] Updated file structure --- .../BubbleSort0824.cpp | 0 .../CMakeLists.txt | 0 .../CMakePresets.json | 0 .../CMakeSFMLProject.cpp | 0 .../DoubleSelectionSort0824.cpp | 0 .../InsertionSort0824.cpp | 0 .../Resources}/Resources/Font/coolvetica_rg_it.otf | Bin .../Resources}/Resources/Textures/background.jpg | Bin .../Resources}/Resources/Textures/infoButton.png | Bin .../SelectionSort0824.cpp | 0 .../ShakerSort0824.cpp | 0 .../algorithm0824.h | 0 info0824.h => Sorting_Algorithms_SFML/info0824.h | 0 13 files changed, 0 insertions(+), 0 deletions(-) rename BubbleSort0824.cpp => Sorting_Algorithms_SFML/BubbleSort0824.cpp (100%) rename CMakeLists.txt => Sorting_Algorithms_SFML/CMakeLists.txt (100%) rename CMakePresets.json => Sorting_Algorithms_SFML/CMakePresets.json (100%) rename CMakeSFMLProject.cpp => Sorting_Algorithms_SFML/CMakeSFMLProject.cpp (100%) rename DoubleSelectionSort0824.cpp => Sorting_Algorithms_SFML/DoubleSelectionSort0824.cpp (100%) rename InsertionSort0824.cpp => Sorting_Algorithms_SFML/InsertionSort0824.cpp (100%) rename {Resources => Sorting_Algorithms_SFML/Resources}/Resources/Font/coolvetica_rg_it.otf (100%) rename {Resources => Sorting_Algorithms_SFML/Resources}/Resources/Textures/background.jpg (100%) rename {Resources => Sorting_Algorithms_SFML/Resources}/Resources/Textures/infoButton.png (100%) rename SelectionSort0824.cpp => Sorting_Algorithms_SFML/SelectionSort0824.cpp (100%) rename ShakerSort0824.cpp => Sorting_Algorithms_SFML/ShakerSort0824.cpp (100%) rename algorithm0824.h => Sorting_Algorithms_SFML/algorithm0824.h (100%) rename info0824.h => Sorting_Algorithms_SFML/info0824.h (100%) diff --git a/BubbleSort0824.cpp b/Sorting_Algorithms_SFML/BubbleSort0824.cpp similarity index 100% rename from BubbleSort0824.cpp rename to Sorting_Algorithms_SFML/BubbleSort0824.cpp diff --git a/CMakeLists.txt b/Sorting_Algorithms_SFML/CMakeLists.txt similarity index 100% rename from CMakeLists.txt rename to Sorting_Algorithms_SFML/CMakeLists.txt diff --git a/CMakePresets.json b/Sorting_Algorithms_SFML/CMakePresets.json similarity index 100% rename from CMakePresets.json rename to Sorting_Algorithms_SFML/CMakePresets.json diff --git a/CMakeSFMLProject.cpp b/Sorting_Algorithms_SFML/CMakeSFMLProject.cpp similarity index 100% rename from CMakeSFMLProject.cpp rename to Sorting_Algorithms_SFML/CMakeSFMLProject.cpp diff --git a/DoubleSelectionSort0824.cpp b/Sorting_Algorithms_SFML/DoubleSelectionSort0824.cpp similarity index 100% rename from DoubleSelectionSort0824.cpp rename to Sorting_Algorithms_SFML/DoubleSelectionSort0824.cpp diff --git a/InsertionSort0824.cpp b/Sorting_Algorithms_SFML/InsertionSort0824.cpp similarity index 100% rename from InsertionSort0824.cpp rename to Sorting_Algorithms_SFML/InsertionSort0824.cpp diff --git a/Resources/Resources/Font/coolvetica_rg_it.otf b/Sorting_Algorithms_SFML/Resources/Resources/Font/coolvetica_rg_it.otf similarity index 100% rename from Resources/Resources/Font/coolvetica_rg_it.otf rename to Sorting_Algorithms_SFML/Resources/Resources/Font/coolvetica_rg_it.otf diff --git a/Resources/Resources/Textures/background.jpg b/Sorting_Algorithms_SFML/Resources/Resources/Textures/background.jpg similarity index 100% rename from Resources/Resources/Textures/background.jpg rename to Sorting_Algorithms_SFML/Resources/Resources/Textures/background.jpg diff --git a/Resources/Resources/Textures/infoButton.png b/Sorting_Algorithms_SFML/Resources/Resources/Textures/infoButton.png similarity index 100% rename from Resources/Resources/Textures/infoButton.png rename to Sorting_Algorithms_SFML/Resources/Resources/Textures/infoButton.png diff --git a/SelectionSort0824.cpp b/Sorting_Algorithms_SFML/SelectionSort0824.cpp similarity index 100% rename from SelectionSort0824.cpp rename to Sorting_Algorithms_SFML/SelectionSort0824.cpp diff --git a/ShakerSort0824.cpp b/Sorting_Algorithms_SFML/ShakerSort0824.cpp similarity index 100% rename from ShakerSort0824.cpp rename to Sorting_Algorithms_SFML/ShakerSort0824.cpp diff --git a/algorithm0824.h b/Sorting_Algorithms_SFML/algorithm0824.h similarity index 100% rename from algorithm0824.h rename to Sorting_Algorithms_SFML/algorithm0824.h diff --git a/info0824.h b/Sorting_Algorithms_SFML/info0824.h similarity index 100% rename from info0824.h rename to Sorting_Algorithms_SFML/info0824.h From 372e72f78ad399b57fe02fb4fc75fe467665bcc0 Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Mon, 1 Apr 2024 17:02:13 +0300 Subject: [PATCH 4/6] Updated README-images folder name --- {ReadMe_img => README-images}/menu.png | Bin {ReadMe_img => README-images}/sorting_algorithm.gif | Bin README.md | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename {ReadMe_img => README-images}/menu.png (100%) rename {ReadMe_img => README-images}/sorting_algorithm.gif (100%) diff --git a/ReadMe_img/menu.png b/README-images/menu.png similarity index 100% rename from ReadMe_img/menu.png rename to README-images/menu.png diff --git a/ReadMe_img/sorting_algorithm.gif b/README-images/sorting_algorithm.gif similarity index 100% rename from ReadMe_img/sorting_algorithm.gif rename to README-images/sorting_algorithm.gif diff --git a/README.md b/README.md index 15cb0bb..22e9303 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Sorting Algorithm Visualisation -![menu_picture](ReadMe_img/menu.png) +![menu_picture](README-images/menu.png) Educational Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works. __EDUCATIONAL APPLICATION__ @@ -11,7 +11,7 @@ __EDUCATIONAL APPLICATION__ 1. Insertion Sort ## 💪 Features - ![Sorting_Algorithm_Gif](ReadMe_img/sorting_algorithm.gif) + ![Sorting_Algorithm_Gif](README-images/sorting_algorithm.gif) - 5 Different Sorting Algorithms - Change number of Bars to be sorted - Change FrameRate (FPS) cap From 0963ba315e0902f736f421e683edd4a130fb4052 Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Mon, 1 Apr 2024 17:02:54 +0300 Subject: [PATCH 5/6] Emoji added --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 22e9303..8d0dbaa 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Educational Sorting algorithms visualisation made using SFML and C++, used to learn how a sorting algorithm works. __EDUCATIONAL APPLICATION__ -## Available algorithms +## 📊 Available algorithms 1. Bubble sort 1. Shaker (Coctail) Sort 1. Selection Sort From c5500a90e047b3807d1edd2b5d11dd3f19a7c7f8 Mon Sep 17 00:00:00 2001 From: SteponasK <132608893+SteponasK@users.noreply.github.com> Date: Mon, 1 Apr 2024 17:03:10 +0300 Subject: [PATCH 6/6] Emoji added --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d0dbaa..1953417 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Howerer feel free to fork this project, and experiment with your own modificatio * **SteponasK** - *Initial work* -## License +## 📜 License This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the [LICENSE](LICENSE.txt) file for details