Splitting up the README files master_201209031639
authorChristian Strømme <christian.stromme@nokia.com>
Fri, 24 Aug 2012 15:21:36 +0000 (17:21 +0200)
committerQt by Nokia <qt-info@nokia.com>
Mon, 3 Sep 2012 05:02:20 +0000 (07:02 +0200)
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>
README
README.git [new file with mode: 0644]

diff --git a/README b/README
index 56670b1..89e9ee9 100644 (file)
--- a/README
+++ b/README
@@ -5,8 +5,23 @@ HOW TO BUILD QT5
  Synopsis
  ========
 
-     See http://qt-project.org/wiki/Building-Qt-5-from-Git for instructions
-     on building Qt 5.
+   System requirements
+   ------------------
+
+    - Perl 5.8 or later
+    - Python 2.7 or later
+    - C++ compiler supporting the C++98 standard
+
+     For other platform specific requirements,
+     please see section "Setting up your machine" on:
+     http://qt-project.org/wiki/Get_The_Source
+
+   Optional requirements
+   ---------------------
+
+   - OpenSSL for SSL sockets or HTTPS
+   - Wayland
+   - See QtWebKit section.
 
    New dependencies in Qt 5
    ------------------------
@@ -78,49 +93,6 @@ HOW TO BUILD QT5
      set WEBKITOUTPUTDIR=%CD%/WebKitBuild
      perl Tools\Scripts\build-webkit --qt --qmake=..\qtbase\bin\qmake.exe --install-libs=<install dir> --release --makeargs=%MAKEFLAGS%
 
- Get The Submodules
- ==================
-
- Obtaining the source code is described in detail at
- http://qt-project.org/wiki/Category:Developing_Qt and
- http://qt-project.org/wiki/Get_The_Source.
-
- 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>'
-
 
  Build!
  ======
@@ -175,3 +147,9 @@ HOW TO BUILD QT5
 
  The qt5_tool in qtrepotools has some more features which may be of interest.
  Try `qt5_tool --help'.
+
+
+ Building Qt5 from git
+ =====================
+ See http://qt-project.org/wiki/Building-Qt-5-from-Git and README.git
+ for more information.
diff --git a/README.git b/README.git
new file mode 100644 (file)
index 0000000..7934bea
--- /dev/null
@@ -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