Add ChangeLog template.
[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 the
53      following tools can be found in the path:
54      * Perl version 5.12 or later   [http://www.activestate.com/activeperl/]
55      * Python version 2.7 or later  [http://www.activestate.com/activepython/]
56      * Ruby version 1.9.3 or later  [http://rubyinstaller.org/]
57
58      cd <path>\qt-everywhere-opensource-src-<version>
59      configure -prefix %CD%\qtbase -opensource -nomake tests
60      nmake // jom // mingw32-make
61
62      To accelerate the bootstrap of qmake with MSVC, it may be useful to pass
63      "-make-tool jom" on the configure command line. If you do not use jom,
64      adding "/MP" to the CL environment variable is a good idea.
65
66  More details follow.
67
68  Build!
69  ======
70
71  A typical `configure; make' build process is used.
72
73  Some relevant configure options (see configure -help):
74
75  -release              Compile and link Qt with debugging turned off.
76  -debug                Compile and link Qt with debugging turned on.
77  -nomake tests         Disable building of tests to speed up compilation
78  -nomake examples      Disable building of examples to speed up compilation
79  -confirm-license      Automatically acknowledge the LGPL 2.1 license.
80
81  Example for a release build:
82  (adjust the `-jN' parameter as appropriate for your system)
83
84    ./configure -prefix $PWD/qtbase -opensource
85    make -j4
86
87  Example for a developer build:
88  (enables more autotests, builds debug version of libraries, ...)
89
90    ./configure -developer-build -opensource
91    make -j4
92
93  See output of `./configure -help' for documentation on various options to
94  configure.
95
96  The above examples will build whatever Qt5 modules have been enabled by
97  default in the build system.
98
99  It is possible to build selected modules with their dependencies by doing
100  a `make module-<foo>'.  For example, to build only qtscript and qtwebkit,
101  and the modules they depend on:
102
103    ./configure -prefix $PWD/qtbase -opensource
104    make -j4 module-qtscript module-qtwebkit
105
106  This can save a lot of time if you are only interested in a subset of Qt5.
107
108
109  Hints
110  =====
111
112  The submodule repository qtrepotools contains useful scripts for
113  developers and release engineers. Consider adding qtrepotools/bin
114  to your PATH environment variable to access them.
115
116  The qt5_tool in qtrepotools has some more features which may be of interest.
117  Try `qt5_tool --help'.
118
119
120  Building Qt5 from git
121  =====================
122  See http://qt-project.org/wiki/Building-Qt-5-from-Git and README.git
123  for more information.
124  See http://qt-project.org/wiki/Qt-5 for the reference platforms.
125
126
127  Documentation
128  =============
129
130  After configuring and compiling Qt, building the documentation is possible by running
131  "make docs".
132
133  After having built the documentation, you need to install it with the following
134  command:
135
136     make install_docs
137
138  The documentation is installed in the path set to $QT_INSTALL_DOCS.
139  Running "qmake -query" will list the value of QT_INSTALL_DOCS.
140
141  Information about Qt 5's documentation is located in qtbase/doc/README
142  or in the following page: http://qt-project.org/wiki/Qt5DocumentationProject
143
144  Note: Building the documentation is only tested on desktop platforms.