This is the user guide for the template and how to adapt it to your own needs.
- Requirements
- Quick Start
- Where is What?
- Make it your own
- Build and Execution
- Testing
- Profiling
- Logging
- Dependencies
- Packaging
- CMake presets
- Platform dependent code
- Application Icons
- Fonts
- High DPI support
This template contains assets, specifically icons and fonts. When starting a new project from a template it gets a clean history. Nevertheless, all assets should be stored through Git Large File Storage (LFS).
As preparation this template contains a .gitattributes marking all necessary files. After project creation from
this
template git lfs migrate
should be executed. It requires Git LFS v2.2.1 or later to be installed.
Have a look at Migrating existing repository data to LFS for an in-depth how-to or run the following commands.
# Initialize Git LFS
git lfs install
# Track files
git mv .gitattributes_example .gitattributes
git commit -m "Add .gitattributes"
# Migrate history to track files and store them in Git LFS
git lfs migrate import --everything --include="*.png,*.tiff,*.bmp,*.ico,*.icns,*.ttf"
git push --force-with-lease
# Clear local .git cache
git reflog expire --expire-unreachable=now --all
git gc --prune=nowThe project uses CMake version >=3.22.
Depending on the operating system, the project uses either Ninja version >=1 for Windows and Linux, or Xcode version >=13 on macOS.
Remark: The SDL2 renderer does not support multi-viewport and detached widgets. For this you can have a look at the OpenGL version of this template.