summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2023-02-08 10:50:10 +0100
committerEike Ziller <eike.ziller@qt.io>2023-02-09 12:40:57 +0000
commit1d5c58775854efdbf6f53277326cd2595260e5fd (patch)
treed05cddc6e9f97f7a9746a3d94b674cf2ee260388 /README.md
parent4e34f1781e0ad4e90475c5dce78a41af79600b64 (diff)
downloadqt-creator-1d5c58775854efdbf6f53277326cd2595260e5fd.tar.gz
README: Add some more information wrt running and installing
Mention explicitly that running Qt Creator from the build directory requires corresponding PATH setup on Windows, and add descriptions for installing development files and debug information. Fixes: QTCREATORBUG-26858 Change-Id: I63381c9ae1af3cd4d5db02a77164061b79ac814f Reviewed-by: Cristian Adam <cristian.adam@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 14493d1afd..73963e434a 100644
--- a/README.md
+++ b/README.md
@@ -148,7 +148,12 @@ optimizations but debug information with `-DCMAKE_BUILD_TYPE=RelWithDebInfo`.
You can find more options in the generated CMakeCache.txt file. For instance,
building of Qbs together with Qt Creator can be enabled with `-DBUILD_QBS=ON`.
-Installation is not needed. It is however possible, using
+Installation is not needed. You can run Qt Creator directly from the build
+directory. On Windows, make sure that your `PATH` environment variable points to
+all required DLLs, like Qt and LLVM. On Linux and macOS, the build already
+contains the necessary `RPATH`s for the dependencies.
+
+If you want to install Qt Creator anyway, that is however possible using
cmake --install . --prefix /path/to/qtcreator_install
@@ -157,6 +162,16 @@ like Qt and LLVM, additionally run
cmake --install . --prefix /path/to/qtcreator_install --component Dependencies
+To install development files like headers, CMake files, and `.lib` files on
+Windows, run
+
+ cmake --install . --prefix /path/to/qtcreator_install --component Devel
+
+If you used the `RelWithDebInfo` configuration and want debug information to be
+available to the installed Qt Creator, run
+
+ cmake --install . --prefix /path/to/qtcreator_install --component DebugInfo
+
### Perf Profiler Support
Support for the [perf](https://perf.wiki.kernel.org/index.php/Main_Page) profiler