b1c97a4975d4d0576340f78359fc711dd3ab5e7a
[mirror/qt/qt5.git] / README
1 HOW TO BUILD QT5
2 ================
3
4
5  Synopsis
6  ========
7
8    System requirements
9    ------------------
10
11     - Perl 5.8 or later
12     - Python 2.7 or later
13     - C++ compiler supporting the C++98 standard
14
15      For other platform specific requirements,
16      please see section "Setting up your machine" on:
17      http://qt-project.org/wiki/Get_The_Source
18
19    Optional requirements
20    ---------------------
21
22    - OpenSSL for SSL sockets or HTTPS
23    - Wayland
24
25    New dependencies in Qt 5
26    ------------------------
27
28      Linux: On systems running X11, the XCB libraries are required for
29      the platform plugin to build. qtbase/src/plugins/platforms/xcb/README
30      lists the required packages.
31
32      Qt 5 can make use of the ICU libraries providing Unicode and Globalization
33      support (see http://site.icu-project.org/). They are required for building
34      QtWebKit.
35      On Linux, they will be auto-detected.
36      On Windows, they need to be manually installed and the "include" and "lib"
37      folders of the ICU installation must be appended to the INCLUDE and LIB
38      environment variables after calling the Windows SDK setup script.
39      The "bin" folder of the ICU installation should be appended to the PATH
40      environment variable in order to for the DLLs to be found at run-time.
41
42    Linux, Mac:
43    -----------
44
45      cd <path>/qt-everywhere-opensource-src-<version>
46      ./configure -prefix $PWD/qtbase -opensource -nomake tests
47      make -j 4
48
49    Windows:
50    --------
51
52      Open a Windows SDK (7.0, 7.1 or later) command prompt. Ensure that Perl
53      version 5.12 or later and Python version 2.7 or later can be found in the
54      path.
55
56      cd <path>\qt-everywhere-opensource-src-<version>
57      configure -prefix %CD%\qtbase -opensource -nomake tests
58      nmake // jom // mingw32-make
59
60      For MinGW (gcc version 4.6 or later), ensure that the compiler can
61      be found in the path.
62
63      To accelerate the bootstrap of qmake with MSVC, it may be useful to pass
64      "-make-tool jom" on the configure command line. If you do not use jom,
65      adding "/MP" to the CL environment variable is a good idea.
66
67  More details follow.
68
69  Build!
70  ======
71
72  A typical `configure; make' build process is used.
73
74  Some relevant configure options (see configure -help):
75
76  -release              Compile and link Qt with debugging turned off.
77  -debug                Compile and link Qt with debugging turned on.
78  -nomake tests         Disable building of tests to speed up compilation
79  -nomake examples      Disable building of examples to speed up compilation
80  -confirm-license      Automatically acknowledge the LGPL 2.1 license.
81
82  Example for a release build:
83  (adjust the `-jN' parameter as appropriate for your system)
84
85    ./configure -prefix $PWD/qtbase -opensource
86    make -j4
87
88  Example for a developer build:
89  (enables more autotests, builds debug version of libraries, ...)
90
91    ./configure -developer-build -opensource
92    make -j4
93
94  See output of `./configure -help' for documentation on various options to
95  configure.
96
97  The above examples will build whatever Qt5 modules have been enabled by
98  default in the build system.
99
100  It is possible to build selected modules with their dependencies by doing
101  a `make module-<foo>'.  For example, to build only qtscript and qtwebkit,
102  and the modules they depend on:
103
104    ./configure -prefix $PWD/qtbase -opensource
105    make -j4 module-qtscript module-qtwebkit
106
107  This can save a lot of time if you are only interested in a subset of Qt5.
108
109
110  Hints
111  =====
112
113  The submodule repository qtrepotools contains useful scripts for
114  developers and release engineers. Consider adding qtrepotools/bin
115  to your PATH environment variable to access them.
116
117  The qt5_tool in qtrepotools has some more features which may be of interest.
118  Try `qt5_tool --help'.
119
120
121  Building Qt5 from git
122  =====================
123  See http://qt-project.org/wiki/Building-Qt-5-from-Git and README.git
124  for more information.