diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-11-18 16:40:55 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-11-28 07:37:46 +0000 |
| commit | 8c9ca9d67d7115574dc843b5fe058f652bc3e0c3 (patch) | |
| tree | 754fbebc9e966e59fe5d8d5c62bd04ee2cc8a024 | |
| parent | 588250efc75b88877c03d43d703e621c148d8ff5 (diff) | |
Doc: Describe registering Qt installations with qtpaths or qmake
In addition to "Qt: Register Qt Installation", you can use
"Qt: Register Qt (qtpaths or qmake)" to register a Qt from
a package manager or a self-built Qt.
Task-number: VSCODEEXT-110
Change-Id: Ibed89a68b0703811eb58e412215bb280bfa76993
Reviewed-by: Orkun Tokdemir <orkun.tokdemir@qt.io>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
| -rw-r--r-- | doc/src/how-to/vscodeext-how-to-register-qt-installations.qdoc | 46 |
1 files changed, 42 insertions, 4 deletions
diff --git a/doc/src/how-to/vscodeext-how-to-register-qt-installations.qdoc b/doc/src/how-to/vscodeext-how-to-register-qt-installations.qdoc index d253dde..1de2333 100644 --- a/doc/src/how-to/vscodeext-how-to-register-qt-installations.qdoc +++ b/doc/src/how-to/vscodeext-how-to-register-qt-installations.qdoc @@ -12,11 +12,35 @@ \title Register Qt installations - The Qt extensions check whether you have a Qt installation folder at the - default path and offer to save it in \l{Qt settings}.Then, they ask you - whether you want to register the Qt versions they found. + To develop with Qt, you need at least one Qt version. You can install Qt in + many ways: - If you installed Qt somewhere else, register your Qt installation: + \list + \li \l{Get and Install Qt with Qt Online Installer}{Use \QOI} + \li Use a package manager + \li \l{Building Qt Sources}{Build Qt from sources} + \endlist + + \section1 Automatic registration + + \QVSC checks whether you have a Qt installation folder at the default path + and offers to save it in \l{Qt settings}. Select \uicontrol Use to save it + and to register the Qt versions in it. + + Also, if you install Qt from \c vcpkg, \QVSC detects it and offers to + create a CMake kit for it. It then uses tools, such as \QD, and paths + from \c vcpkg. Set the \c {QT_QPA_PLATFORM_PLUGIN_PATH} and + \c {QML_IMPORT_PATH} environment variables in the \e launch.json file to + configure the Qt installation. + + If you did not install Qt at the default path, or the \c vcpkg installation + is not detected automatically, register your Qt versions as described in the + following sections. + + \section1 \QOI installations + + To register a Qt that you installed with \QOI to a folder that is not on the + default path: \list 1 \li Go to \uicontrol {Command Palette}, and select @@ -29,6 +53,20 @@ \image vscodeext-kits.webp {CMake kits for installed Qt versions} + \section1 Other installations + + To register a Qt that you installed from a package manager or that you built + from sources: + + \list 1 + \li Go to \uicontrol {Command Palette}, and select + \uicontrol {Qt: Register Qt (qtpaths or qmake)}. + \li Select the \c qmake or \c qtpaths executable, + and then select \uicontrol {Select}. + \endlist + + The command creates a CMake kit for qtpaths. + \section1 Scan for Qt kits If some Qt CMake kits are missing, go to \uicontrol {Command Palette} and |
