summaryrefslogtreecommitdiff
path: root/README.git
diff options
context:
space:
mode:
authorChristian Strømme <christian.stromme@nokia.com>2012-08-24 17:21:36 +0200
committerQt by Nokia <qt-info@nokia.com>2012-09-03 07:02:20 +0200
commit5fc78793130748d2b7b6b6b301a8010738145799 (patch)
treebeb9decd99004a18a0782e573bc1c00ba2cd53be /README.git
parent39136436424a821a99753e9f92ff30ec61742f15 (diff)
downloadqt5-5fc78793130748d2b7b6b6b301a8010738145799.tar.gz
Splitting up the README files
Moved git related information over to README.git, and polished the README file slightly. Change-Id: I863e2c2ef9c2020964185e96ddb87a05d82c30a6 Reviewed-by: Rohan McGovern <rohan.mcgovern@nokia.com>
Diffstat (limited to 'README.git')
-rw-r--r--README.git55
1 files changed, 55 insertions, 0 deletions
diff --git a/README.git b/README.git
new file mode 100644
index 00000000..7934bea9
--- /dev/null
+++ b/README.git
@@ -0,0 +1,55 @@
+OBTAINING QT5 FROM GIT
+======================
+
+ Synopsis
+ ========
+
+ For a more in-depth description on how to build Qt5 from git,
+ please see: http://qt-project.org/wiki/Building-Qt-5-from-Git
+
+
+ Get The Submodules
+ ==================
+
+ Cloning Qt5 does not automatically clone all submodules.
+ To get the submodules, it is recommended to use the `init-repository' script.
+
+ ./init-repository
+
+ See `./init-repository -help' for full documentation on the many supported
+ options.
+
+
+ Update The Submodules (optional)
+ ================================
+
+ After a plain `git clone' and `init-repository', you will have each submodule
+ checked out to a particular SHA1. This combination of SHA1s is guaranteed to
+ have passed some basic acceptance testing.
+
+ If (and only if!) you need newer versions of some submodules, you can manually
+ fetch and/or pull and/or reset any modules you like, or use the qt5_tool to
+ pull all modules:
+
+ ./qtrepotools/bin/qt5_tool -p
+
+ NOTE! As soon as you change the SHA1 of any submodule, you are using a
+ combination of modules which is potentially untested and broken! If you want
+ something which is more likely to compile, stick to the module SHA1s provided
+ in this repository.
+
+
+ Install The Git Grafts (optional)
+ =================================
+
+ If you want to be able to connect the Qt5 and Qt4 development history, you
+ may set up git grafts with the following command:
+
+ git submodule foreach '../qtrepotools/bin/git-qt-grafts <path_to_history>'
+
+
+ Developing and Contributing to Qt
+ ================================
+
+ For more information on how to develop and contribute to Qt, please see:
+ http://qt-project.org/wiki/Category:Developing_Qt