To get started with this project, ensure you have the following tools and libraries:
- CMake (Version 3.14 or later): Essential for building and managing the project files.
- C++ Compiler: Compatible with Clang, GCC, or MSVC. Choose one based on your development environment.
- GTK3 Development Libraries (for Linux users): Necessary for GUI development on Linux platforms.
Having wxWidgets
installed is optional. If the CMake script cannot find it, it will download the library from GitHub and compile it from sources.
Follow these steps to build the project:
-
Create a build directory & configure the build:
cmake -S. -Bbuild
-
Build the project:
cmake --build build -j
This will create a build
directory and compile all necessary artifacts there. The main executable will be located in build/
.
For release build use --config Release
on Windows:
cmake -S. -Bbuild
cmake --build build -j --config Release
Artifacts for both configurations will be generated in the build
directory.
On Mac or Linux you'll need to maintain two build trees:
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
cmake -S. -Bbuild-rel -DCMAKE_BUILD_TYPE=Release
cmake --build build-rel -j
MIT License. Can be used in closed-source commercial products.