Merge pull request #92 from BPLA-Team/umbrella_coding

Minor fixes and updates

Author: UmbrellaLeaf5

.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: Build
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Setup Qt
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: "6.6.0"
+          host: linux
+          target: desktop
+
+      - name: Add Qt to PATH
+        run: echo "$QT_PATH/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake libgl1-mesa-dev libboost-all-dev
+
+      - name: Configure CMake
+        run: |
+          cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
+
+      - name: Build project
+        run: |
+          cmake --build build --config Release --parallel 2

CMakeLists.txt

@@ -26,12 +26,16 @@ set(CMAKE_AUTORCC ON)
 include(cmake_paths.cmake)
 
 # ---------------------------------         Find Qt        ---------------------------------
-find_package(QT NAMES Qt6 Qt5 COMPONENTS Widgets Core PrintSupport REQUIRED)
-find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Widgets Core PrintSupport REQUIRED)
+find_package(QT NAMES Qt6 COMPONENTS Widgets Core PrintSupport REQUIRED)
+find_package(Qt6 COMPONENTS Widgets Core PrintSupport REQUIRED)
 
 # ---------------------------------       Find Boost       ---------------------------------
 set(Boost_USE_STATIC_LIBS OFF)
 
+if(POLICY CMP0167)
+  cmake_policy(SET CMP0167 NEW)
+endif()
+
 find_package(Boost REQUIRED COMPONENTS locale unit_test_framework)
 
 # ---------------------------------   Submodules folders   ---------------------------------

README.md

@@ -7,35 +7,40 @@
 **Project of four first grade MIPT DAFE/RSE students (for engineering practical work in the second semester) in Qt C++**
 
 ## Documentation
-Project's [documentation](https://umbrellaleaf5.github.io/locus_no_pilotus/index.html) generated with Doxygen with [convenient CSS theme](#used-libs-and-sources).
+
+Project's [documentation](https://bpla-team.github.io/locus_no_pilotus/index.html) generated with Doxygen with [convenient CSS theme](#used-libs-and-sources).
 
 # Contents
-  * [Description](#description)
-  * [Installation and configuring](#installation-and-configuring "with using MSYS")
-  * [Used libs and sources](#used-libs-and-sources "we are using GitHub submodules feature 😎")
-  * [Authors](#authors "the best guys")
-  * [Presentation](#presentation "video link")
+
+- [Description](#description)
+- [Installation and configuring](#installation-and-configuring "with using MSYS")
+- [Used libs and sources](#used-libs-and-sources "we are using GitHub submodules feature 😎")
+- [Authors](#authors "the best guys")
+- [Presentation](#presentation "video link")
 
 ## Description
 
-In this project, we are developing an application that calculates the trajectory of a flying delivery robot that collects valuable cargo from control points: **Targets**. 
-On its way, it may encounter high mountains that it cannot fly over: **Hills**; or elliptical territories that are impossible to visit due to climate conditions: **TrappyCircles**. 
-Also, through some control points, the robot is simply unable to move, as the cargo may not be ready for transportation at that time, these are **TrappyLines**. 
+In this project, we are developing an application that calculates the trajectory of a flying delivery robot that collects valuable cargo from control points: **Targets**.
+On its way, it may encounter high mountains that it cannot fly over: **Hills**; or elliptical territories that are impossible to visit due to climate conditions: **TrappyCircles**.
+Also, through some control points, the robot is simply unable to move, as the cargo may not be ready for transportation at that time, these are **TrappyLines**.
 
-The robot's trajectory is calculated using several mathematical algorithms: [...]. 
-The graphical interface for constructing the trajectory was created using [Qt](#used-libs-and-sources) and [QCustomPlot](#used-libs-and-sources). 
+The robot's trajectory is calculated using several mathematical algorithms: [...].
+The graphical interface for constructing the trajectory was created using [Qt](#used-libs-and-sources) and [QCustomPlot](#used-libs-and-sources).
 
-In the application, you can add objects using window forms, interact with the trajectory calculation plot using the mouse cursor, create and open files in ```.json``` format with a specific style for this application. Editing objects can also be done with cursors or using a special dynamic input field with tables, opened in a separate window mode or embedded in the main one. 
+In the application, you can add objects using window forms, interact with the trajectory calculation plot using the mouse cursor, create and open files in `.json` format with a specific style for this application. Editing objects can also be done with cursors or using a special dynamic input field with tables, opened in a separate window mode or embedded in the main one.
 
-*We strongly recommend that you install our application using the instructions below and try it out!*
+_We strongly recommend that you install our application using the instructions below and try it out!_
 
 ## Installation and configuring
 
 #### On Windows 64 bit system
-1) Install **[MSYS2](https://www.msys2.org/)** to any convenient folder as compiler setup
-> *P.S. of course you can try install all the libs and packages used in repo manually, but our team got pain and tears trying to install Boost on MINGW in this way, so we recommend to install MSYS (besides, it is an excellent tool for compiling any other C++ and etc. projects)*
 
-2) Open ```MSYS2 MSYS``` console, copy the command below and paste it with ```Shift+Ins``` or ```RBM and 'Paste'``` to download all the packages used in our project
+1. Install **[MSYS2](https://www.msys2.org/)** to any convenient folder as compiler setup
+
+   > _P.S. of course you can try install all the libs and packages used in repo manually, but our team got pain and tears trying to install Boost on MINGW in this way, so we recommend to install MSYS (besides, it is an excellent tool for compiling any other C++ and etc. projects)_
+
+2. Open `MSYS2 MSYS` console, copy the command below and paste it with `Shift+Ins` or `RBM and 'Paste'` to download all the packages used in our project
+
 ```
 pacman -S mingw-w64-x86_64-gcc
 pacman -S mingw-w64-x86_64-gdb
@@ -46,50 +51,51 @@ pacman -S mingw-w64-x86_64-boost
 pacman -S mingw-w64-x86_64-clang
 ```
 
-3) Install **[Git Bash](https://gitforwindows.org/)** to any convenient folder (if you haven't get it yet) 
+3. Install **[Git Bash](https://gitforwindows.org/)** to any convenient folder (if you haven't get it yet)
+
+4. Open `Git Bash` and use command like `cd C:/CodeFolder` to go to the folder where you usually save the code
 
-4) Open ```Git Bash``` and use command like ```cd C:/CodeFolder``` to go to the folder where you usually save the code
+5. Clone our repo with including submodules to such folder:
 
-5) Clone our repo with including submodules to such folder:
-``` 
-git clone --recurse-submodules https://github.com/UmbrellaLeaf5/locus_no_pilotus 
 ```
+git clone --recurse-submodules https://github.com/BPLA-Team/locus_no_pilotus
+```
+
+6. Open the MSYS bin folder in path like `C:\YourPathToMsys\msys64\mingw64\bin` than find and start `qtcreator.exe`
 
-6) Open the MSYS bin folder in path like ```C:\YourPathToMsys\msys64\mingw64\bin``` than find and start ```qtcreator.exe```
+7. In folder with our project clone find **_CMakeLists.txt_** and open it with QtCreator
 
-7) In folder with our project clone find ***CMakeLists.txt*** and open it with QtCreator
+8. Set the compiler that allow _CMake_ configuration in the kits list and click `Configure Project`
 
-8) Set the compiler that allow *CMake* configuration in the kits list and click ```Configure Project```
+9. To use the full working version: **Build** (hammer button in the lower left corner) the project, and after ending process with error use **_Build > Run CMake_** in the top menu to reconfigure and fix error with including QCustomPlot
 
-9) To use the full working version: **Build** (hammer button in the lower left corner) the project, and after ending process with error use ***Build > Run CMake*** in the top menu to reconfigure and fix error with including QCustomPlot
-> *P.S. because of using QCustomPlot, we need to copy additional .lib file to build directory, and our script does this when activating the Run CMake command*
+   > _P.S. because of using QCustomPlot, we need to copy additional .lib file to build directory, and our script does this when activating the Run CMake command_
 
-10) Now you can use full working project with **Run** (green triangle button in the lower left corner)!
+10. Now you can use full working project with **Run** (green triangle button in the lower left corner)!
 
 #### On Linux system
 
-*Coming soon...*
+_Coming soon..._
 
 > Much respect and help for this installation method to [George Sukhanov](https://github.com/TheFueRr "our colleague with an equally interesting project on processing experimental data")!
 
 ## Used libs and sources
-* [CMake](https://cmake.org/): main project build system
-* [Qt](https://www.qt.io/): main project library for full-working program
-* [QCustomPlot](https://www.qcustomplot.com/): library for drawing all objects on same place with autoscaling ([submodule](https://github.com/UmbrellaLeaf5/qcustomplot "reference for submodule with lib in GitHub"))
-* [IceCream-Cpp](https://github.com/renatoGarcia/icecream-cpp): library for simple code debugging (we really recommend to use it in C++ projects)
-* [Doxygen](https://www.doxygen.nl/): full documentation generation
-* [Doxygen Awesome](https://github.com/jothepro/doxygen-awesome-css): convenient CSS theme for Doxygen HTML documentation (it is really awesome)
-* [Flaticon](https://www.flaticon.com/): perfect icons source
-* [GeoGebra](https://www.geogebra.org/): best platform for geometry calculations
+
+- [CMake](https://cmake.org/): main project build system
+- [Qt](https://www.qt.io/): main project library for full-working program
+- [QCustomPlot](https://www.qcustomplot.com/): library for drawing all objects on same place with autoscaling ([submodule](https://github.com/UmbrellaLeaf5/qcustomplot "reference for submodule with lib in GitHub"))
+- [IceCream-Cpp](https://github.com/renatoGarcia/icecream-cpp): library for simple code debugging (we really recommend to use it in C++ projects)
+- [Doxygen](https://www.doxygen.nl/): full documentation generation
+- [Doxygen Awesome](https://github.com/jothepro/doxygen-awesome-css): convenient CSS theme for Doxygen HTML documentation (it is really awesome)
+- [Flaticon](https://www.flaticon.com/): perfect icons source
+- [GeoGebra](https://www.geogebra.org/): best platform for geometry calculations
 
 ## Authors
+
 **[Romanov Fedor](https://github.com/Romanov-Fedor "math greatest gigachad and refactor guy (also Desmos and GeoGebra proger)")**
 
 **[Rybalkin Ilya](https://github.com/Stargazer2005 "traveling salesman problem and Dijkstra algos enjoyer, the trajectory guy")**
 
 **[Akramov Nikita](https://github.com/MrWh1teF0x "jsons, add forms, cursors, animation, scale hero")**
 
 **[Krivoruchko Dmitry](https://github.com/UmbrellaLeaf5 "repo manager and gui guy with tables instead of muscles and arcs instead of veins")**
-
-## Presentation
-**[Video-presentation](https://disk.yandex.ru/i/R-6LPpjHcT5Fdw)** of out project on Russian language (with all team members).