.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]: <replace me>"
+labels: bug, needs triage
+assignees: ''
+
+---
+
+## Describe you problem:
+*replace me*
+
+## Steps to reproduce (optional):
+*replace me*
+
+## Additional info (optional):
+*replace me*
+
+## Possible fix (optional):
+*replace me*
+
+## OS
+- [ ] : Windows
+- [ ] : Mac OS
+- [x] : Linux

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,17 @@
+---
+name: Documentation
+about: Suggest a change in the documentation
+title: "[DOC]: <replace me>"
+labels: documentation, needs triage
+assignees: ''
+
+---
+
+## Which part of the documentation?
+- [x]  Wiki
+- [ ] Readme
+- [ ] Code comments
+- [ ] Others
+
+# Describe your suggestion
+*replace me*

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]: <replace me>"
+labels: enhancement, needs triage
+assignees: ''
+
+---
+
+## Feature description:
+*replace me*
+
+## Additional info (optional):
+*replace me*

.gitignore

@@ -1,2 +1,3 @@
 .vscode
-sorting-visualizer
+sorting-visualizer
+build/

CMakeLists.txt

@@ -0,0 +1,45 @@
+cmake_minimum_required(VERSION 3.22)
+project(sorting-visualizer)
+
+set(default_build_type "Release")
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+  message( STATUS "Setting build type to '${default_build_type}' as none was specified.")
+  set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE STRING "Choose the type of build." FORCE)
+  # Set the possible values of build type for cmake-gui
+  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+    "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+endif()
+
+set(SFML_DIR "C:/Program Files (x86)/SFML/lib/cmake/SFML")
+
+find_package(SFML COMPONENTS graphics window CONFIG REQUIRED)
+
+add_executable(sorting-visualizer src/main.cpp src/Sortable.cpp src/SortAlgorithms.cpp src/SortController.cpp src/Utils.cpp)
+
+target_link_libraries(sorting-visualizer sfml-graphics sfml-window)
+
+# Copy across .dlls for windows users
+get_target_property(SFML_TYPE sfml-graphics TYPE)
+if(SFML_TYPE STREQUAL "SHARED_LIBRARY")
+  message(STATUS "Copying sfml-graphics DLLs to ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>")
+  add_custom_command(
+  TARGET sorting-visualizer POST_BUILD
+  COMMAND ${CMAKE_COMMAND} -E copy
+  $<TARGET_FILE:sfml-graphics>
+  ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>)
+
+  message(STATUS "Copying sfml-window DLLs to ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>")  
+  add_custom_command(
+  TARGET sorting-visualizer POST_BUILD
+  COMMAND ${CMAKE_COMMAND} -E copy
+  $<TARGET_FILE:sfml-window>
+  ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>)
+
+  message(STATUS "Copying sfml-system DLLs to ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>")  
+  add_custom_command(
+  TARGET sorting-visualizer POST_BUILD
+  COMMAND ${CMAKE_COMMAND} -E copy
+  $<TARGET_FILE:sfml-system>
+  ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>)
+endif()
+

README.md

@@ -1,37 +1,73 @@
-# Sorting Visualizer 📚
+# 📊 Sorting Visualizer
 
 A lightweight sorting visualizer made with C++ and [SFML](https://www.sfml-dev.org/index.php).
 
-![Bubble sort](https://i.imgur.com/iFIRllR.png) <br>
-*Bubble sort*
+| ![Quick sort gif](https://i.imgur.com/TsWwumg.gif) |
+|:--:|
+| *Quick sort* |
 
-![Bubble sort info](https://i.imgur.com/lZL6G0a.png) <br>
-*Sort info*
+| ![Bubble visualizer](https://i.imgur.com/086SZ51.png) |
+|:--:|
+| *Bubble sort* |
 
-## I want to contribute to the project! 📖
-If you want to contibute or understand the code better, go to the Wiki tab or press [here](https://github.com/alesbe/sorting-visualizer/wiki)!
+| ![Bubble sort info](https://i.imgur.com/P5ypw86.png) |
+|:--:|
+| *Bubble sort info* |
 
-## Sort types 🗂️
-- Bubble sort
-- Selection sort
-- Insertion sort
-- Quick sort
+## 📖 I want to contribute to the project!
+Awesome! [Here](https://github.com/alesbe/sorting-visualizer/wiki) you can find some useful info about the visualizer, we accept first contributors too!
 
-## Usage 🕹️
-**h**: Display help <br>
-**F1**: Change number of elements <br>
-**F2**: Change time between comparisons <br>
-**Arrow Up / Arrow down**: Change sort type <br>
-**Space**: Start sort <br>
-**Backspace**: Stop sort
+*Also, make sure to pull the last changes from [dev](https://github.com/alesbe/sorting-visualizer/tree/dev) branch!*
 
-## Download 🖨️
-- Pre-compiled .exe (windows) [Releases](https://github.com/alesbe/sorting-visualizer/releases). <br>
-**Note: The libraries are static, so they are all included in a single exe, some browsers may detect this as a possible threat, feel free to compile it yourself instead of downloading the pre-compiled exe!**
+## 🗂️ Sort types
+- **Bubble sort**
+  - Bubble sort works by continuously swapping elements next to each other that are in the wrong place. Starting from the beginning of the dataset, each element 'floats' to its correct spot. More on Bubble sort can be found [here](https://www.geeksforgeeks.org/bubble-sort/).
+- **Selection sort**
+  - Selection sort works by having two sections, the sorted and unsorted sections, and continuously search through the unsorted section and place the smallest element into the sorted section. This sorting algorithm could be implemented where the largest element is selected instead. More on selection sort can be found [here](https://www.geeksforgeeks.org/selection-sort/).
+- **Insertion sort**
+  - Insertion sort is similar to selection sort in that they both have a sorted and unsorted section. Instead of continuously selected the smallest/largest element, it will insert a selected element from the unsorted portion and 'insert' it into the correct spot in the sorted section. More on insertion sort can be found [here](https://www.geeksforgeeks.org/insertion-sort/).
+- **Quick sort**
+  - Quick sort is a "Divide and Conquer" algorithm. Divide and Conquer algorithms work by splitting the problem into smaller portions, solving the smaller problems, then combing the solutions into one final solution. Quick sort works by choosing an element as a 'pivot', moving the other elements around where elements less than the pivot are on one side and elements greater than the pivot are on the other, then continuously doing that process with each side. Once each element has been partitioned, the solution is combined into the sorted array. More on quick sort can be found [here](https://www.geeksforgeeks.org/quick-sort/) and more on Divide and Conquer algorithms can be found [here](https://www.geeksforgeeks.org/introduction-to-divide-and-conquer-algorithm-data-structure-and-algorithm-tutorials/).
+- **Cocktail shaker sort**
+  - Cocktail shaker sort is a variant of Bubble Sort. Instead of only having elements 'float' from the bottom to its correct spot in the dataset, elements also 'sink' from the top of the datset into its correct position. More on cocktail shaker sort can be found [here](https://www.geeksforgeeks.org/cocktail-sort/).
+- **Bogo sort**
+  - Bogo sort is an inefficient sorting algorithm where it randomly generates different versions of the original dataset and checks if it's sorted or not. More on bogo sort can be found [here](https://www.geeksforgeeks.org/bogosort-permutation-sort/).
+- **Bitonic sort**
+  - Bitonic sort is a comparison based sorting algorithm that can be run with parallel implementation. Within different subarrays, the algorithm checks if the first element is smaller than the second and vice versa. It continuously does that on larger subarrays until the whole dataset is sorted. More on bitonic sort can be found [here](https://www.geeksforgeeks.org/bitonic-sort/).
+- **Odd-Even sort**
+  - Odd-Even sort is comparassion vased sorting algorithm developed for use on pararell processors, its based on bubble sort but is divided into two phases Odd and Even Phase. On Odd phase algorithm performs bubble sort on odd indexed elements, during even phase on even indexed elements. More on Odd-Even sort can be found [here](https://www.geeksforgeeks.org/odd-even-sort-brick-sort/).
 
-or
 
-- Compile the code yourself (linux/macos) (Follow [this](https://github.com/alesbe/sorting-visualizer/wiki/How-to-compile-compile-the-project) guide).
+## 🕹️ Usage
+- **Space**: Start sort <br>
+- **Backspace**: Stop sort <br>
+- **h**: Display help <br>
+- **F1**: Change number of elements <br>
+- **F2**: Change time between comparisons <br>
+- **Arrow Up / Arrow down**: Change sort type <br>
 
-## License 📜
-[MIT License](https://github.com/alesbe/sorting-visualizer/blob/main/LICENSE)
+## 🖨️ Download
+**Requirements:**
+- CMake
+
+### 🐧 Linux
+- Clone the project: `git clone https://github.com/alesbe/sorting-visualizer && cd sorting-visualizer`
+- Run `./install.sh`
+
+### 🖥️ Windows / MacOS
+#### [Download from releases](https://github.com/alesbe/sorting-visualizer/releases/)
+
+If you want to compile the project by yourself you need to follow the next steps:
+1. Download SFML from the [official website](https://www.sfml-dev.org/download/sfml/2.6.1/)
+2. Download [CMake](https://cmake.org/download/)
+3. Clone the repository
+4. Open `CMakeLists.txt` and locate the variable `SFML_DIR`. Set the path to the route where the SFML CMake files are located. For instance `C:/Program Files (x86)/SFML/lib/cmake/SFML`.
+5. From the root directory of the repository, run:
+```
+mkdir build cd build
+cmake ..
+cmake -G 'Visual Studio 17 2022' ..
+```
+6. In the `/build` directory should be a Visual Studio solution. Now you can open the solution and compile the file with the play button as usual!
+
+_Note: If you don't want to use Visual Studio 2022, download SFML for your target compiler and change the cmake generator in step 6. You can check the list of generators with cmake -G_