80573dd36b
There are many Qt submodules, and it would be beneficial to users if there was a standard README template that will enable them to understand and access the submodule content better. Currently many of the submodules do not have README documents, or if they do, each submodule varies vastly regarding what content is in the document. This proposed README template is based on the Git ReadMe structure. Task-number: QTBUG-114809 Pick-to: 6.5 6.6 Change-Id: I3d1d1da27ed665e76ee6d1df8a93c3e5a920b0a3 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Amir Masoud Abdol <amir.abdol@qt.io> |
||
|---|---|---|
| LICENSES | ||
| cmake | ||
| coin | ||
| qt3d@877ac9c47a | ||
| qt5compat@f7b780b8e8 | ||
| qtactiveqt@939575465a | ||
| qtbase@e456232ad3 | ||
| qtcanvas3d@1319e0965f | ||
| qtcharts@3a6bc0e435 | ||
| qtcoap@f8c8f5fe5c | ||
| qtconnectivity@61505b99a5 | ||
| qtdatavis3d@9c61043516 | ||
| qtdeclarative@7e16e2211a | ||
| qtdoc@51b26472df | ||
| qtfeedback@9ac8d8c272 | ||
| qtgamepad@5fe6fd206f | ||
| qtgraphs@c9539c4e98 | ||
| qtgrpc@f5dc6f5510 | ||
| qthttpserver@8ddf61cea1 | ||
| qtimageformats@a85387d227 | ||
| qtlanguageserver@2aaa58fac5 | ||
| qtlocation@e39eeda649 | ||
| qtlottie@d9c0a880a9 | ||
| qtmqtt@7f23a7a848 | ||
| qtmultimedia@932cd5577b | ||
| qtnetworkauth@63acb49771 | ||
| qtopcua@f01c27055c | ||
| qtpim@02efef5ee6 | ||
| qtpositioning@0ef6f7f64d | ||
| qtqa@b74017291e | ||
| qtquick3d@f007b72825 | ||
| qtquick3dphysics@59dfae00db | ||
| qtquickeffectmaker@8711c1a9fb | ||
| qtquicktimeline@c9e0d4bb9b | ||
| qtremoteobjects@c7b8a40648 | ||
| qtrepotools@925e5722f5 | ||
| qtscxml@3b0727e1a5 | ||
| qtsensors@0fdeefbff3 | ||
| qtserialbus@4f54cd51f7 | ||
| qtserialport@d650928a06 | ||
| qtshadertools@95d3c7fcc7 | ||
| qtspeech@f8616b10e5 | ||
| qtsvg@3fd27ee0d3 | ||
| qtsystems@434af789f0 | ||
| qttools@53b770c4e0 | ||
| qttranslations@d59ebb549b | ||
| qtvirtualkeyboard@a010b8a6e4 | ||
| qtwayland@99c71c495b | ||
| qtwebchannel@2b3b121d7a | ||
| qtwebengine@9913864bd7 | ||
| qtwebglplugin@531fb30d53 | ||
| qtwebsockets@5fe7ec6e51 | ||
| qtwebview@8036609bf1 | ||
| qtxmlpatterns@05ab444844 | ||
| .commit-template | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .tag | ||
| CMakeLists.txt | ||
| LICENSE.GPL2 | ||
| LICENSE.GPL3 | ||
| LICENSE.GPL3-EXCEPT | ||
| LICENSE.LGPL3 | ||
| LICENSE.QT-LICENSE-AGREEMENT | ||
| README.git | ||
| README.md | ||
| README.md.template | ||
| _clang-format | ||
| configure | ||
| configure.bat | ||
| configure.json | ||
| init-repository | ||
README.md
HOW TO BUILD Qt 6
Synopsis
System requirements
- C++ compiler supporting the C++17 standard
- CMake
- Ninja
- Python 3
For more details, see also https://doc.qt.io/qt-6/build-sources.html
Linux, Mac:
cd <path>/<source_package>
./configure -prefix $PWD/qtbase
cmake --build .
Windows:
- Open a command prompt.
- Ensure that the following tools can be found in the path:
- Supported compiler (Visual Studio 2019 or later, or MinGW-builds gcc 8.1 or later)
- Python 3 ([https://www.python.org/downloads/windows/] or from Microsoft Store)
cd <path>\<source_package>
configure -prefix %CD%\qtbase
cmake --build .
More details follow.
Build!
Qt is built with CMake, and a typical
configure && cmake --build . build process is used.
If Ninja is installed, it is automatically chosen as CMake generator.
Some relevant configure options (see configure -help):
-releaseCompile and link Qt with debugging turned off.-debugCompile and link Qt with debugging turned on.
Example for a release build:
./configure -prefix $PWD/qtbase
cmake --build .
Example for a developer build: (enables more autotests, builds debug version of libraries, ...)
./configure -developer-build
cmake --build .
See output of ./configure -help for documentation on various options to
configure.
The above examples will build whatever Qt modules have been enabled by default in the build system.
It is possible to build selected repositories with their dependencies by doing
a ninja <repo-name>/all. For example, to build only qtdeclarative,
and the modules it depends on:
./configure
ninja qtdeclarative/all
This can save a lot of time if you are only interested in a subset of Qt.
Hints
The submodule repository qtrepotools contains useful scripts for
developers and release engineers. Consider adding qtrepotools/bin
to your PATH environment variable to access them.
Building Qt from git
See http://wiki.qt.io/Building_Qt_6_from_Git and README.git for more information. See http://wiki.qt.io/Qt_6 for the reference platforms.
Documentation
After configuring and compiling Qt, building the documentation is possible by running
cmake --build . --target docs
After having built the documentation, you need to install it with the following command:
cmake --build . --target install_docs
The documentation is installed in the path specified with the
configure argument -docdir.
Information about Qt's documentation is located in qtbase/doc/README
Note: Building the documentation is only tested on desktop platforms.