sobruce / qt-cmake-vscode

Develop your own cross-platform desktop apps using Qt, CMake and VSCode

Qt + CMake cross-platform app template for VSCode

This is intended as a template for developing distributable cross-platform Qt (LGPL) desktop apps in VSCode rather than using QtCreator. Supported platforms for deployment are Windows 10 and above and macOS 10.15+. Included is a script for code signing and notarization for macOS deploymemt. Linux deployment is not currently supported.

A word of warning

Simply using this template does not automatically make your app compliant to Qt's LGPL requirements, which you can read about here.

Development minimum requirements

• Windows 10 / macOS 12 (macOS 10.15 is sufficient if deploying the app is not required)
• Qt 6.x (L)GPL for desktop development
• CMake 3.22 or above
• VSCode with CMake Tools (Microsoft) extension installed

Setting up

If you are on Windows, before following the steps below, add Qt's MinGW bin folder to the system's PATH environment variable. For Qt 6.4.0, the MinGW bin folder is located at:

C:\Qt\Tools\mingw1120_64\bin

Set up the project in VSCode:

1. Open VSCode and select 'Open Folder...' from the 'File' menu.
2. Select the root folder of this repo.
3. Respond with 'Yes' to configuring the project with CMake.
4. Check the paths in cmake/Qt.cmake and change them to match your Qt's installation folder.
5. Click on CMake's Kit icon in the status bar (the one that looks like a spanner) to select the CMake compiler:
   • Clang on macOS
   • MinGW on Windows

You are now ready to build, run or debug the app. After building, the app can be found in the build directory, however, this build is unlikely to work on other machines. To distribute the app, follow the steps in the 'Deployment' section below.

Deployment

1. Select the 'Release' build variant in the status bar.
2. Click on [Template] to change the default build target to [install]
3. Press 'Build' in the status bar.

The build/dist folder will contain the distributable app.

Customizing the app

Set your application name, version, source files and other information in cmake/AppInfo.cmake.

To change the application icon, replace the *.ico (Windows) and *.icns (macOS) files in the resources folder, setting ICON_NAME to the base file name (without the file extension) in AppInfo.cmake. The macOS utility script macos/png2ico.sh generates ICO and ICNS files from a PNG, should you need it. There are many online tools which convert uploaded images into icons, such as this one.

If developing a macOS agent (a.k.a. service or deamon) which must run without a task bar icon, set MACOSX_IS_AGENT to TRUE in AppInfo.cmake.

Resource files who's data is needed at runtime should be placed in the resources folder and listed in resources.qrc.

Code completion

Code completion in VSCode should work on Windows by default. To enable code completion on macOS, set up the following configuration in .vscode/c_cpp_properties.json:

    "configurations": [
        {
            "name": "Mac",
            "includePath": [
                "${workspaceFolder}"
            ],
            "defines": [],
            "macFrameworkPath": ["/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks"],
            "compilerPath": "/usr/bin/clang",
            "cStandard": "gnu17",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "${default}",
            "configurationProvider": "ms-vscode.cmake-tools"
        }
    ],

macOS notarization

You'll need the following in order to notarize your app:

• A 'Developer ID Application' certificate (https://developer.apple.com/account/resources/certificates/list)
• Your Apple developer ID
• An application password for your app which you can create at: https://appleid.apple.com/

Create a file .credentials in the root folder of this repo with the following contents and fill out the corresponding information:

BUNDLE_SIGN_CERT="Developer ID Application: ___ ___ (____)"
NOTARIZE_APPLE_ID="___@___.com"
NOTARIZE_APP_PASS="____-____-____-____"

Whenever you are ready to notarize a build, run the following command after building the [install] target:

bash build/notarize.sh

You will be prompted to press the [RETURN] key when your app has been notarized. Press the key after you receive an email confiramtion so that the your app is stapled with the approval. Your notarized app will be moved into the build/notarized folder.

Known issues

• Spaces in the app name are replaced with underscores '_' in order for Qt's deployment tools to work. You'll need to manually rename the application file after deployment if you want to retain the spaces in its name.
• Certain app information such as the company name or copyright does not appear in the Windows executable file properties.