summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2023-03-29 12:21:50 +0200
committerEike Ziller <eike.ziller@qt.io>2023-03-29 12:21:50 +0200
commitb36287731eb8ab3895a1e7e19f071009dd1c1ad4 (patch)
tree4a9999b27058b8efee4ed74cd40f4f16dd97b34f /README.md
parent6ab923c39fd4ac66edb3cf708e3c789cb4a31428 (diff)
parent81a5e2143cb7728316e02d24925f853e2db2099a (diff)
downloadqt-creator-b36287731eb8ab3895a1e7e19f071009dd1c1ad4.tar.gz
Merge remote-tracking branch 'origin/10.0'
Conflicts: cmake/QtCreatorIDEBranding.cmake qbs/modules/qtc/qtc.qbs src/plugins/remotelinux/genericlinuxdeviceconfigurationwidget.cpp src/tools/perfparser Change-Id: Ie5643100e0eb00e0933359dce320169b876f5634
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1866b96052..4a97db2efc 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,32 @@ Prerequisites:
The used toolchain has to be compatible with the one Qt was compiled with.
+### Getting Qt Creator from Git
+
+The official mirror of the Qt Creator repository is located at
+https://code.qt.io/cgit/qt-creator/qt-creator.git/. Run
+
+ git clone https://code.qt.io/qt-creator/qt-creator.git
+
+to clone the Qt Creator sources from there. This creates a checkout of the
+Qt Creator sources in the `qt-creator/` directory of your current working
+directory.
+
+Qt Creator relies on some submodules, like
+[litehtml](https://github.com/litehtml) for displaying documentation. Get these
+submodules with
+
+ cd qt-creator # switch to the sources, if you just ran git clone
+ git submodule update --init --recursive
+
+Note the `--recursive` in this command, which fetches also submodules within
+submodules, and is necessary to get all the sources.
+
+The git history contains some coding style cleanup commits, which you might
+want to exclude for example when running `git blame`. Do this by running
+
+ git config blame.ignoreRevsFile .gitignore-blame
+
### Linux and macOS
These instructions assume that Ninja is installed and in the `PATH`, Qt Creator