Repository navigation
Developer Environment Setup
GridLock relies on modern C++23 features and a robust native toolchain. We use Meson + Ninja for rapid compilation and CQtDeployer for creating distribution AppImages.
Warning
Official Support: Arch Linux is the only officially tested and supported platform for developing GridLock. Wayland QPA stability and raw memory zero-copy (process_vm_readv) have not been verified against the kernel configurations of the untested OS variants below.
sudo pacman -S meson ninja qt6-base qt6-declarative qt6-svg qt6-wayland \
vulkan-devel openmpi lldb llvm clang cqtdeployersudo dnf install meson ninja-build qt6-qtbase-devel qt6-qtdeclarative-devel \
qt6-qtsvg-devel qt6-qtwayland-devel vulkan-devel openmpi-devel lldb llvm clangsudo apt-get update
sudo apt-get install meson ninja-build qt6-base-dev qt6-declarative-dev \
libqt6svg6-dev qt6-wayland libvulkan-dev libopenmpi-dev lldb llvm clangsudo zypper install meson ninja qt6-base-devel qt6-declarative-devel \
qt6-svg-devel qt6-wayland-devel vulkan-devel openmpi-devel lldb llvm clangnix-shell -p meson ninja qt6.qtbase qt6.qtdeclarative qt6.qtsvg qt6.qtwayland \
vulkan-headers openmpi lldb llvm clangGridLock utilizes a standard Meson out-of-source build structure.
# 1. Setup the build directory
meson setup builddir
# 2. Compile using Ninja
meson compile -C builddir
# 3. Run the development binary
./builddir/src/gridlockTo bundle the GridLock executable with its required Qt6 shared libraries and generate an AppImage for distribution, use our deployment script:
# This relies on the system having cqtdeployer available
./scripts/deploy.shGridLock Repository | Releases | Report an Issue | Roadmap | Accessibility | License (MIT)
Documentation mirrored from docs/ on master.
User Guides
Architecture & Plan
Developer Docs