README.md

Demo application using the MIT-licensed Qt 6 bindings for Zig

This demo application can be thought of as a simpler instructive template for using the main library than the examples. Please try out the demo application and start a discussion if you have any questions or issues relevant to this demo application.

TABLE OF CONTENTS

• License
• Building
  • FreeBSD (native)
  • Linux (native)
    • Debian-based distributions
    • Fedora-based distributions
    • Arch-based distributions
    • openSUSE-based distributions
  • macOS (native)
  • Windows (native)
• Screenshots
• FAQ
  • Q1. How long does it take to compile the demo application?
  • Q2. What build modes are supported by the demo application?
• Special Thanks

License

The demo application within libqt6zig-demo is licensed under the MIT license.

Building

FreeBSD (native)

sudo pkg install qt6-base

Linux (native)

Debian-based distributions

sudo apt install gcc libstdc++-14-dev-$(dpkg --print-architecture)-cross qt6-base-dev

Fedora-based distributions

sudo dnf install gcc libstdc++-devel qt6-qtbase-devel

Arch-based distributions

sudo pacman -S gcc qt6-base

openSUSE-based distributions

sudo zypper install qt6-base-devel

macOS (native)

To install the Qt 6 dependency using Homebrew:

brew install qt6

ln -s /opt/homebrew/lib/QtCore.framework/Headers /opt/homebrew/include/QtCore
ln -s /opt/homebrew/lib/QtGui.framework/Headers /opt/homebrew/include/QtGui
ln -s /opt/homebrew/lib/QtWidgets.framework/Headers /opt/homebrew/include/QtWidgets

The official Qt installer is also supported but will require manually creating the symlinks as above and using the extra-paths option described below, using the root of the include directory as the path value.

Windows (native)

For Windows, use the official Qt installer and install a Qt version built with LLVM-MinGW.

Once the required packages are installed, the demo application can be built from the root of the repository:

zig build

To build and run the demo application:

zig build run

In the event that another system library path is needed e.g. a different Qt installation path, the extra-paths option supports this use case:

zig build -Dextra-paths="C:/Qt/6/llvm-mingw_64"

or

zig build -Dextra-paths={"/opt/qt6","/opt/lib/qt6"}

For Windows hosts, there is an additional option to specify the Qt installation directory. This is only required if passing in an alternate extra library path meant to override the default Qt library path:

zig build -Dextra-paths="C:/Qt/6/llvm-mingw_64" -DQTDIR="C:/Qt/6/llvm-mingw_64"

The demo application can be installed to the system in a non-default location by adding the --prefix-exe-dir option to the build command:

sudo zig build --prefix-exe-dir /usr/local/bin # creates /usr/local/bin/mdoutliner

The source code for the demo application can be found in the src directory of the repository.

Screenshots

CachyOS + KDE
Fedora + KDE
FreeBSD + Xfce
Linux Mint + Cinnamon
macOS
Windows

FAQ

Q1. How long does it take to compile the demo application?

The first compilation should take less than a minute, far less on more recent or capable hardware.

Q2. What build modes are supported by the demo application?

Currently, Debug, ReleaseFast, ReleaseSafe, and ReleaseSmall are supported. The default build mode is Debug. To change the build mode:

zig build -Doptimize=ReleaseSmall

or

zig build --release=small

Special Thanks

• @mappu for the MIQT bindings that provided the phenomenal foundation for this project

• @arnetheduck for proving the value of collaboration on the back-end of the library while working across different target languages