Upgrade documentation and add missing parts

Author: MartinHelmut

docs/ApplicationIcons.md

@@ -5,15 +5,17 @@
 ### macOS
 
 To generate a `.icns` file on macOS, an `.iconset` folder needs to be converted via `iconutil`. The
-folder `src/assets/icons/icon.iconset` contains all needed icon sizes. To generate the needed app icon under `src/assets/icons/icon.icns`, run from inside the `src/assets/icons` folder:
+folder `src/assets/icons/icon.iconset` contains all needed icon sizes. To generate the needed app icon
+under `src/assets/icons/icon.icns`, run from inside the `src/assets/icons` folder:
 
 ```shell
 iconutil -c icns icon.iconset
 ```
 
 ### Windows
 
-To create the `icon.ico` file [ImageMagick](https://www.imagemagick.org) is used. From inside the `src/assets/icons` folder run:
+To create the `icon.ico` file [ImageMagick](https://www.imagemagick.org) is used. From inside the `src/assets/icons`
+folder run:
 
 ```shell
 convert \
@@ -31,29 +33,35 @@ identify icon.ico
 
 ### Linux
 
-There is no need to generate an icon set for Linux. A high resolution PNG (1024x1024px) is enough for the app icon. This is located under `icons/BaseAppIcon.png`.
+There is no need to generate an icon set for Linux. A high resolution PNG (1024x1024px) is enough for the app icon. This
+is located under `icons/BaseAppIcon.png`.
 
 ## Icon design guidelines
 
-The example project contains an example icon. To get guiding for creating an own unique app icon, here a couple of resources:
+The example project contains an example icon. To get guiding for creating an own unique app icon, here a couple of
+resources:
 
 - [Windows app icon guidelines](https://learn.microsoft.com/en-us/windows/apps/design/style/iconography/app-icon-design)
 - [Apple human interface design, icons guide](https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons/)
 
 ## Integrating icons
 
-How are those application icons connected to become the icon of the generated executable? Through the packaging process and manifest files.
+How are those application icons connected to become the icon of the generated executable? Through the packaging process
+and manifest files.
 
 ### Package app icons
 
-For macOS and Windows app icons are packed as static resources via CMake's [target_sources](https://cmake.org/cmake/help/latest/command/target_sources.html) function in `src/app/cmake/AppAssets.cmake`. For example, adding the Windows `.ico` file to the main executable:
+For macOS and Windows app icons are packed as static resources via
+CMake's [target_sources](https://cmake.org/cmake/help/latest/command/target_sources.html) function
+in `src/app/cmake/AppAssets.cmake`. For example, adding the Windows `.ico` file to the main executable:
 
 ```cmake
 # src/app/cmake/AppAssets.cmake
 target_sources(App PUBLIC ${PROJECT_SOURCE_DIR}/src/assets/icons/icon.ico)
 ```
 
-On Linux, it needs to be part of the installation process that is defined in `src/app/cmake/packaging/Linux.cmake`, where application icons are installed in a shared directory `share/pixmaps`. This does look like the following:
+On Linux, it needs to be part of the installation process that is defined in `src/app/cmake/packaging/Linux.cmake`,
+where application icons are installed in a shared directory `share/pixmaps`. This does look like the following:
 
 ```cmake
 # src/app/cmake/packaging/Linux.cmake
@@ -67,7 +75,13 @@ The manifest files then link the app icon to the executable.
 
 #### macOS
 
-For macOS the manifest file is an [Info.plist](https://developer.apple.com/documentation/bundleresources/information_property_list) defining application properties. It is located at `src/app/Manifests/Info.plist` and added to the app bundle through `src/app/cmake/packaging/Darwin.cmake`. Here the CMake function [set_target_properties](https://cmake.org/cmake/help/latest/command/set_target_properties.html) defines `MACOSX_BUNDLE_INFO_PLIST` for the manifest location. The icon name is defined inside the `Info.plist` file under the property name `CFBundleIconFile`.
+For macOS the manifest file is
+an [Info.plist](https://developer.apple.com/documentation/bundleresources/information_property_list) defining
+application properties. It is located at `src/app/Manifests/Info.plist` and added to the app bundle
+through `src/app/cmake/packaging/Darwin.cmake`. Here the CMake
+function [set_target_properties](https://cmake.org/cmake/help/latest/command/set_target_properties.html)
+defines `MACOSX_BUNDLE_INFO_PLIST` for the manifest location. The icon name is defined inside the `Info.plist` file
+under the property name `CFBundleIconFile`.
 
 ```cmake
 # src/app/cmake/packaging/Darwin.cmake
@@ -79,19 +93,25 @@ set_target_properties(App PROPERTIES
 
 #### Windows
 
-The resource file `src/app/Manifests/app.rc` will bind the icon to the Windows executable. The resource file itself is then added as part of the application bundle via [target_sources](https://cmake.org/cmake/help/latest/command/target_sources.html) in `src/app/cmake/AppAssets.cmake`.
+The resource file `src/app/Manifests/app.rc` will bind the icon to the Windows executable. The resource file itself is
+then added as part of the application bundle
+via [target_sources](https://cmake.org/cmake/help/latest/command/target_sources.html)
+in `src/app/cmake/AppAssets.cmake`.
 
 ```cmake
 target_sources(App PUBLIC
-    ${PROJECT_SOURCE_DIR}/src/assets/icons/icon.ico
-    ${PROJECT_SOURCE_DIR}/src/app/Manifests/app.rc)
+  ${PROJECT_SOURCE_DIR}/src/assets/icons/icon.ico
+  ${PROJECT_SOURCE_DIR}/src/app/Manifests/app.rc)
 ```
 
 #### Linux
 
-For Linux a `src/app/Manifests/App.desktop.in` defines the created shortcut with icon. The `.in` file will be processed by CMake via [configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html) in `src/app/cmake/packaging/Linux.cmake`.
+For Linux a `src/app/Manifests/App.desktop.in` defines the created shortcut with icon. The `.in` file will be processed
+by CMake via [configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
+in `src/app/cmake/packaging/Linux.cmake`.
 
-It will take the `.in` file and produce a final `.desktop` file for Linux with the given icon name under the property `Icon=`.
+It will take the `.in` file and produce a final `.desktop` file for Linux with the given icon name under the
+property `Icon=`.
 
 ```cmake
 # src/app/cmake/packaging/Linux.cmake

docs/BuildAndExecution.md

@@ -26,7 +26,8 @@ cmake -GNinja -DCMAKE_BUILD_TYPE=Debug -DDEACTIVATE_LOGGING -B build/debug
 
 ### `DEBUG`
 
-Will not only enable application internal debugging, but also profiling (`APP_PROFILE`). This option is mainly useful to get debugging and profiling output on release builds.
+Will not only enable application internal debugging, but also profiling (`APP_PROFILE`). This option is mainly useful to
+get debugging and profiling output on release builds.
 
 **Example:**
 
@@ -64,31 +65,39 @@ After configuration the application can be built through CMake via `cmake --buil
 cmake --build build/debug
 ```
 
-This will build the application with the given configuration. Depending on the platform it was executed on a different build directory structure will be generated, reflecting how the application will latter be [installed on packaging](Packaging.md).
+This will build the application with the given configuration. Depending on the platform it was executed on a different
+build directory structure will be generated, reflecting how the application will latter
+be [installed on packaging](Packaging.md).
 
 ## Execute
 
-When not running through an [IDE like CLion](https://www.jetbrains.com/clion), the built application can be run by directly executing the generated binary. Depending on the operating system it can be found at a different place, as different build directory structures are generated.
+When not running through an [IDE like CLion](https://www.jetbrains.com/clion), the built application can be run by
+directly executing the generated binary. Depending on the operating system it can be found at a different place, as
+different build directory structures are generated.
 
 ### macOS
 
-On Apple devices an app package structure is created under `./build/<TARGET>/src/app/App.app`, where `<TARGET>` is the build target like **debug** or **release**. Inside that [application bundle](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/AboutBundles/AboutBundles.html#//apple_ref/doc/uid/10000123i-CH100-SW1) is the app executable.
+On Apple devices an app package structure is created under `./build/<TARGET>/src/app/App.app`, where `<TARGET>` is the
+build target like **debug** or **release**. Inside
+that [application bundle](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/AboutBundles/AboutBundles.html#//apple_ref/doc/uid/10000123i-CH100-SW1)
+is the app executable.
 
 Run on a built target, in this example **debug**:
 
 ```shell
 ./build/debug/src/app/App.app/Contents/MacOS/App
 ```
 
-Though, even better is to use **XCode as generator** to create app builds on macOS. Only difference in usage is running CMake with `-GXCode`. If `CMAKE_OSX_ARCHITECTURES` is not set, it will create universal binaries on M1/2 macs.
+Though, even better is to use **Xcode as generator** to create app builds on macOS. Only difference in usage is running
+CMake with `-GXcode`. If `CMAKE_OSX_ARCHITECTURES` is not set, it will create universal binaries on M1/2 macs.
 
-To run a **debug** build created with XCode:
+To run a **debug** build created with Xcode:
 
 ```shell
 ./build/xcode/src/app/Debug/App.app/Contents/MacOS/App
 ```
 
-To run a **release** build created with XCode:
+To run a **release** build created with Xcode:
 
 ```shell
 ./build/xcode/src/app/Release/App.app/Contents/MacOS/App
@@ -110,7 +119,8 @@ build/release/src/app/App.exe
 
 ### Linux
 
-For Linux the generated structure is a direct executable, as libraries and assets have dedicated locations on the system.
+For Linux the generated structure is a direct executable, as libraries and assets have dedicated locations on the
+system.
 
 Run on a built target, in this example **debug**:
 

docs/CMakePresets.md

@@ -0,0 +1,84 @@
+# CMake Presets
+
+The template uses [Cmake Presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html), enabling a
+convenient way of running CMake, CTest, and CPack.
+
+You can find out more about presets in
+the [official CMake documentation about Presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html). I
+also wrote an [article as a
+TL;DR on CMake presets](https://martin-fieber.de/blog/cmake-presets/), giving an overview of how to define and work with
+them.
+
+## Configure
+
+To list all available configure presets, some dependent on the current system:
+
+```shell
+cmake --list-presets
+```
+
+Run configure presets by name:
+
+```shell
+cmake --preset debug
+```
+
+## Build
+
+To list all available build presets, some dependent on the current system:
+
+```shell
+cmake --build --list-presets
+```
+
+Run build presets by name:
+
+```shell
+cmake --build --preset debug
+```
+
+## Test
+
+To list all available test presets:
+
+```shell
+ctest --list-presets
+```
+
+Run test presets by name, executing CTest:
+
+```shell
+ctest --preset all
+```
+
+## Packaging
+
+To list all available packaging presets, some dependent on the current system:
+
+```shell
+cpack --list-presets
+```
+
+Run packaging presets by name, executing CPack:
+
+```shell
+cpack --preset release
+```
+
+## Workflows
+
+To list all available workflows, some dependent on the current system:
+
+```shell
+cmake --workflow --list-presets
+```
+
+Run a workflow by name:
+
+```shell
+cmake --workflow --preset dist
+```
+
+***
+
+Next up: [Platform dependent code](PlatformCode.md)

docs/Fonts.md

@@ -1,10 +1,12 @@
 # Fonts
 
-Applications fonts are in `src/assets/fonts`, and the template comes with the amazing open source font [Manrope](https://manropefont.com).
+Applications fonts are in `src/assets/fonts`, and the template comes with the amazing open source
+font [Manrope](https://manropefont.com).
 
 ## Add new font
 
-After adding a new font to the `src/assets/fonts` folder, the fonts needs to be added to ImGUI. This is done in `src/core/Core/Application.cpp`, the `run` method.
+After adding a new font to the `src/assets/fonts` folder, the fonts needs to be added to ImGUI. This is done
+in `src/core/Core/Application.cpp`, the `run` method.
 
 ```c++
 ExitStatus App::Application::run() {

docs/HighDPISupport.md

@@ -1,13 +1,16 @@
 # High DPI support
 
-The template app supports high DPI displays out-of-the-box. The header `src/core/Core/DPIHandler.hpp` defines the interface for DPI handling. The implementations are in `src/core/Platform` under `DPIHandler.cpp` per platform.
+The template app supports high DPI displays out-of-the-box. The header `src/core/Core/DPIHandler.hpp` defines the
+interface for DPI handling. The implementations are in `src/core/Platform` under `DPIHandler.cpp` per platform.
 
 The following two functions are important for DPI handling.
 
 ## `get_scale()`
 
-Returns a `float` scaling factor used to set render and font scale. Should be used whenever a relative scaling is needed. See usage in platform `DPIhandler.cpp` files and `src/core/Core/Application.cpp`, `run` method.
+Returns a `float` scaling factor used to set render and font scale. Should be used whenever a relative scaling is
+needed. See usage in platform `DPIhandler.cpp` files and `src/core/Core/Application.cpp`, `run` method.
 
 ## `get_dpi_aware_window_size()`
 
-Returns a `WindowSize`, a struct with height and width as `int`. Will scale `Window::Settings` DPI aware per platform. See file `src/core/Core/Window.cpp`.
+Returns a `WindowSize`, a struct with height and width as `int`. Will scale `Window::Settings` DPI aware per platform.
+See file `src/core/Core/Window.cpp`.

docs/Logging.md

@@ -1,6 +1,8 @@
 # Logging
 
-The library [spdlog](https://github.com/gabime/spdlog) is used for logging. The logger is set up in `src/core/Core/Log.{cpp,hpp}` that will define a default logger writing to stdout and into a `app.log` file. The macros used for logging are defined in `src/core/Core/Log.hpp`.
+The library [spdlog](https://github.com/gabime/spdlog) is used for logging. The logger is set up
+in `src/core/Core/Log.{cpp,hpp}` that will define a default logger writing to stdout and into a `app.log` file. The
+macros used for logging are defined in `src/core/Core/Log.hpp`.
 
 ## Available macros
 

docs/MakeItYourOwn.md

@@ -4,7 +4,9 @@ There are some variables and settings that should be adapted to specific project
 
 ## Project name and company
 
-Inside the root `CMakeLists.txt`, the CMake [project](https://cmake.org/cmake/help/latest/command/project.html) call also defines the project name as `CMAKE_PROJECT_NAME` variable. This is currently called `BasicGuiProjectSetup`. Here an example how this could look like:
+Inside the root `CMakeLists.txt`, the CMake [project](https://cmake.org/cmake/help/latest/command/project.html) call
+also defines the project name as `CMAKE_PROJECT_NAME` variable. This is currently called `BasicGuiProjectSetup`. Here an
+example how this could look like:
 
 ```cmake
 # CMakeLists.txt
@@ -15,7 +17,8 @@ project(
   LANGUAGES CXX)
 ```
 
-In that same file, the **project company name and namespace** ([Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation)) are defined.
+In that same file, the **project company name and namespace
+** ([Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation)) are defined.
 
 ```cmake
 # CMakeLists.txt
@@ -28,15 +31,18 @@ set(PROJECT_COMPANY_NAMESPACE "com.mycompany")  # Reverse domain name notation
 
 ## App icons
 
-App icons are located under `src/assets/icons/`. There is dedicated documentation on how to update and integrate those into the project under [Application Icons](ApplicationIcons.md).
+App icons are located under `src/assets/icons/`. There is dedicated documentation on how to update and integrate those
+into the project under [Application Icons](ApplicationIcons.md).
 
 ## Installer graphics
 
-The installer on macOS and Windows are graphical and use some images to properly represent the app. Images and documentation for macOS are in `packaging/dmg/`, same for Windows under `packaging/nsis/`.
+The installer on macOS and Windows are graphical and use some images to properly represent the app. Images and
+documentation for macOS are in `packaging/dmg/`, same for Windows under `packaging/nsis/`.
 
 ## Code of conduct
 
-There is a basic Code of Conduct (CoC) provided by https://www.contributor-covenant.org in `CODE_OF_CONDUCT.md`. Search for `EMAIL` inside that document to provide a contact for the CoC.
+There is a basic Code of Conduct (CoC) provided by https://www.contributor-covenant.org in `CODE_OF_CONDUCT.md`. Search
+for `EMAIL` inside that document to provide a contact for the CoC.
 
 ***