CuteHMI is an open-source HMI (Human Machine Interface) software written in C++ and QML, using Qt libraries as a framework.

Note: While most of the project uses GNU Lesser General Public License version 3, some files are distributed under different licenses.

Branch "master" is a development branch. Development branch may contain source code that is undergoing deep changes, rendering it unusable. Consecutive branch numbers denote successive iterations of the project.

Branch	Build status	Development status
master		pre-alpha
1		alpha

1. Get the Qt toolkit. Open-source and commercial editions can be obtained from https://www.qt.io/. Qt can also be shipped with Linux distribution.

2. Open CuteHMI.qbs file with QtCreator and simply build it.

3. All extensions dependent on external libraries will be disabled, if these libraries could not be found. To make the process of finding the libraries and installing them under Windows easier, a set of Makefiles is provided, which allows the libraries to be build from sources. Check out external libraries for more details. Each extension may provide individual documentation on how to build it.

Remember that Qbs caches Probe items' results, so if the library is installed after the project has been configured with Qbs, it will not show up. You can use --force-probe-execution option to force Qbs to not use cached results.

Refer to documentation of each individual tool on how to run examples.

Directory structure of the project is organized as follows.

• _sass, _layouts - directories used by GitHub Pages.
• awkgward - code maintanance scripts (don't bother).
• dev - development notes (irrelevant).
• doc - a place where documentation shall be.
• examples - self-explanatory.
• extensions - libraries and QML extensions.
• external - directory containing "external" libraries.
• extra - various stuff related to the project, such as T-shirts.
• qbs - Qbs modules and imports.
• tools - end-user applications.

Two most important directories are extensions and tools. Extensions combine functionality of QML extensions and standard libraries. They can be utilized by end-user applications, but they can be also linked with each other. Some extensions may depend on external libraries.

• Repository
• Website
• Documentation