Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stemoretti/qt-desktop-template

Template for creating applications for Linux, Windows and MacOS using the Qt widgets framework
https://github.com/stemoretti/qt-desktop-template

Last synced: 2 months ago
JSON representation

Template for creating applications for Linux, Windows and MacOS using the Qt widgets framework

Host: GitHub
URL: https://github.com/stemoretti/qt-desktop-template
Owner: stemoretti
License: unlicense
Created: 2019-10-02T08:11:14.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-07-25T13:56:26.000Z (over 1 year ago)
Last Synced: 2024-08-02T00:26:15.415Z (5 months ago)
Language: C++
Homepage:
Size: 159 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

awesome-appimage - Qt Desktop Template - Template for creating Qt Widgets desktop applications with AppImage generation using linuxdeployqt. (AppImage developer tools / Templates)

README

        .. .. image:: https://travis-ci.com/stemoretti/qt-desktop-template.svg?branch=master

  :target: https://travis-ci.com/stemoretti/qt-desktop-template

.. image:: https://github.com/stemoretti/qt-desktop-template/actions/workflows/appimage.yml/badge.svg

  :target: https://github.com/stemoretti/qt-desktop-template/actions?query=workflow%3AAppImage

.. image:: https://github.com/stemoretti/qt-desktop-template/actions/workflows/flatpak.yml/badge.svg

  :target: https://github.com/stemoretti/qt-desktop-template/actions?query=workflow%3AFlatpak

.. image:: https://github.com/stemoretti/qt-desktop-template/actions/workflows/snap.yml/badge.svg

  :target: https://github.com/stemoretti/qt-desktop-template/actions?query=workflow%3ASnap

.. image:: https://github.com/stemoretti/qt-desktop-template/actions/workflows/windows.yml/badge.svg

  :target: https://github.com/stemoretti/qt-desktop-template/actions?query=workflow%3AWindows

.. image:: https://github.com/stemoretti/qt-desktop-template/actions/workflows/macos.yml/badge.svg

  :target: https://github.com/stemoretti/qt-desktop-template/actions?query=workflow%3AMacOS

Qt Desktop Template

===================

Template for creating applications for Linux, Windows and macOS with

the Qt Widgets framework.

How to build

------------

Requirements

^^^^^^^^^^^^

The following software is required to compile this application:

* A compiler that supports C++17

* CMake >= 3.19

* Qt >= 6.2

Compiling and installing under Linux

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: console

  git clone https://github.com/stemoretti/qt-desktop-template.git

  cd qt-desktop-template

  mkdir build

  cd build

  cmake ..

  make

  make install

The default CMake installation prefix is ``/usr/local``. You can change it by

redefining the option CMAKE_INSTALL_PREFIX in the configuration stage.

(e.g. ``cmake -DCMAKE_INSTALL_PREFIX=/usr ..``)

Compiling and running under Windows

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Clone the repository with git software like `Github Desktop `__.

It's easier to compile the program using an IDE such as Qt Creator.

Instructions on how to download and install it can be found

`here `__.

Information on how to use it to build and run programs can be found

`here `__.

Compiling and creating a bundle under macOS

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: console

  git clone https://github.com/stemoretti/qt-desktop-template.git

  cd qt-desktop-template

  cmake -B build -G "Ninja"

  cmake --build build

The bundle directory is automatically created inside the build directory.

However, it doesn't contain the libraries that the program needs to run.

To deploy the required Qt libraries into the bundle, run the following command.

.. code:: console

  macdeployqt "Qt Desktop Template.app" [-dmg]

The optional `-dmg` option is for creating a dmg disk image file.

Translations

------------

Translations are stored in ``.ts`` files inside the ``translations`` folder.

Their name contains the language code of the translation they provide.

To add languages, follow the steps below.

* Add the translation's file path of the language you wish to support to the

  variable ``TS_FILES`` inside the file

  `CMakeLists.txt `__.

* Configure the project by running CMake.

* Run the following command to generate the ``.ts`` file of each language:

  .. code:: console

    make update_translations

* Open the newly created file with the Qt tool ``linguist``.

  Translate the program's texts and save the file.

The binary translation files will be created automatically during the compilation.

Credits

-------

Software used for CI deployment:

* `aqtinstall `__

* `linuxdeployqt `__

See also

--------

Other similar templates:

* `QtApp-Template `__

* `mini-cmake-qt `__

* `cmake-init `__

* `cpp_starter_project `__