Update submodules on '5.6' in qt5
[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://wiki.qt.io/Get_The_Source
18
19    Licensing:
20    ----------
21
22     Opensource users:
23
24         <source_package> = qt-everywhere-opensource-src-<version>
25         <license>        = -opensource
26
27     Commercial users:
28
29         <source_package> = qt-everywhere-enterprise-src-<version>
30         <license>        = -commercial
31
32    Linux, Mac:
33    -----------
34
35      cd <path>/<source_package>
36      ./configure -prefix $PWD/qtbase <license> -nomake tests
37      make -j 4
38
39    Windows:
40    --------
41
42      Open a Windows SDK (7.0, 7.1 or later) command prompt. Ensure that the
43      following tools can be found in the path:
44      * Perl version 5.12 or later   [http://www.activestate.com/activeperl/]
45      * Python version 2.7 or later  [http://www.activestate.com/activepython/]
46      * Ruby version 1.9.3 or later  [http://rubyinstaller.org/]
47
48      cd <path>\<source_package>
49      configure -prefix %CD%\qtbase <license> -nomake tests
50      nmake // jom // mingw32-make
51
52      To accelerate the bootstrap of qmake with MSVC, it may be useful to pass
53      "-make-tool jom" on the configure command line. If you do not use jom,
54      adding "/MP" to the CL environment variable is a good idea.
55
56  More details follow.
57
58  Build!
59  ======
60
61  A typical `configure; make' build process is used.
62
63  Some relevant configure options (see configure -help):
64
65  -release              Compile and link Qt with debugging turned off.
66  -debug                Compile and link Qt with debugging turned on.
67  -nomake tests         Disable building of tests to speed up compilation
68  -nomake examples      Disable building of examples to speed up compilation
69  -confirm-license      Automatically acknowledge the LGPL 2.1 license.
70
71  Example for a release build:
72  (adjust the `-jN' parameter as appropriate for your system)
73
74    ./configure -prefix $PWD/qtbase <license>
75    make -j4
76
77  Example for a developer build:
78  (enables more autotests, builds debug version of libraries, ...)
79
80    ./configure -developer-build <license>
81    make -j4
82
83  See output of `./configure -help' for documentation on various options to
84  configure.
85
86  The above examples will build whatever Qt5 modules have been enabled by
87  default in the build system.
88
89  It is possible to build selected modules with their dependencies by doing
90  a `make module-<foo>'.  For example, to build only qtdeclarative,
91  and the modules it depends on:
92
93    ./configure -prefix $PWD/qtbase <license>
94    make -j4 module-qtdeclarative
95
96  This can save a lot of time if you are only interested in a subset of Qt5.
97
98
99  Hints
100  =====
101
102  The submodule repository qtrepotools contains useful scripts for
103  developers and release engineers. Consider adding qtrepotools/bin
104  to your PATH environment variable to access them.
105
106  The qt5_tool in qtrepotools has some more features which may be of interest.
107  Try `qt5_tool --help'.
108
109
110  Building Qt5 from git
111  =====================
112  See http://wiki.qt.io/Building_Qt_5_from_Git and README.git
113  for more information.
114  See http://wiki.qt.io/Qt_5 for the reference platforms.
115
116
117  Documentation
118  =============
119
120  After configuring and compiling Qt, building the documentation is possible by running
121  "make docs".
122
123  After having built the documentation, you need to install it with the following
124  command:
125
126     make install_docs
127
128  The documentation is installed in the path set to $QT_INSTALL_DOCS.
129  Running "qmake -query" will list the value of QT_INSTALL_DOCS.
130
131  Information about Qt 5's documentation is located in qtbase/doc/README
132  or in the following page: http://wiki.qt.io/Qt5DocumentationProject
133
134  Note: Building the documentation is only tested on desktop platforms.