Build Instructions (GNU/Linux)

Build Instructions

Prerequisites

Install required system packages:

>  cmake build-essential libwxgtk3.0-gtk3-dev libgl1-mesa-dev libglu1-mesa-dev

Build the Project

From the root of the repository:

cmake -B build
cmake --build build

The final executable will be located in the bin/ directory.

./bin/GLOverlayUI

This project requires a few dependencies to be installed beforehand.

On Linux, ensure the following packages are available:

sudo <your package-manager-install> cmake build-essential libwxgtk3.0-gtk3-dev \
     libgl1-mesa-dev libglu1-mesa-dev

Warning

To find out the names of the packages, please search using your package manager. The names may vary depending on the Linux distribution.

Optional (for documentation build):

A requirements.txt file is already provided in the docs/ folder.

The project can be built with the classic CMake commands:

cmake -B build
cmake --build build

After compilation, the executable will be generated in the ./bin directory at the root of the project.

To run the application:

./bin/GLOverlayUI

The build system has been extended to also generate documentation from source code. For this, you need both Python and Doxygen installed.

It is recommended to create a Python virtual environment:

python3 -m venv dist
source dist/bin/activate
pip install -r docs/requirements.txt

Then enable documentation build when running CMake:

cmake -B build -DBUILD_DOC=ON
cmake --build build

After a successful build, documentation can be viewed in two forms:

To preview locally, you can serve them with Python:

# Sphinx
python3 -m http.server -d ./docs/_build/html

# Doxygen
python3 -m http.server -d ./docs/_doxy/html

The documentation is also published online:

If you encounter problems building the project or discover bugs, please open an issue on the GitHub repository.

Happy hacking Folks! 🚀