Bump version
[qt-creator:qt-creator.git] / README
1 Qt Creator
2 ==========
3 Qt Creator is a cross-platform IDE for development with the Qt framework.
4
5 Supported Platforms
6 ===================
7 The standalone binary packages support the following platforms:
8
9 Windows XP SP3 or later
10 (K)Ubuntu Linux 11.10 (32-bit and 64-bit) or later
11 Mac OS X 10.7 or later
12
13 Building the sources requires Qt 5.3.1 or later.
14
15 Compiling Qt Creator
16 ====================
17 Prerequisites:
18    * Qt 5.3.1 or later
19    * On Windows:
20      -  ActiveState Active Perl
21      -  MinGW with g++ 4.5 or Visual Studio 2010 or later
22      -  jom
23    * On Mac OS X: latest Xcode
24    * On Linux: g++ 4.5 or later
25
26 The installed toolchains have to match the one Qt was compiled with.
27
28 You can build Qt Creator with
29
30     cd $SOURCE_DIRECTORY
31     qmake -r
32     make (or mingw32-make or nmake or jom, depending on your platform)
33
34 Installation ("make install") is not needed. It is however possible, using
35
36     make install INSTALL_ROOT=$INSTALL_DIRECTORY
37
38 Compiling Qt and Qt Creator on Windows
39 --------------------------------------
40
41 This section provides step by step instructions for compiling the latest
42 versions of Qt and Qt Creator on Windows. Alternatively, to avoid having to
43 compile Qt yourself, you can use one of the versions of Qt shipped with the Qt
44 SDK (release builds of Qt using MinGW and Visual C++ 2010 or later).
45 For detailed information on the supported compilers, see
46 http://wiki.qt.io/Building_Qt_5_from_Git .
47
48    1.  Decide which compiler to use: MinGW or Microsoft Visual Studio. If you
49        plan to contribute to Qt Creator, you should compile your changes with
50        both compilers.
51
52    2.  Install msysGit from https://msysgit.github.io/. If you plan to
53        use the MinGW compiler suite, do not choose to put git in the
54        default path of Windows command prompts. For more information, see
55        step 9.
56
57    3.  Create a working directory under which to check out Qt and Qt Creator,
58        for example, c:\work. If you plan to use MinGW and Microsoft Visual
59        Studio simultaneously or mix different Qt versions, we recommend
60        creating a directory structure which reflects that. For example:
61        C:\work\qt5.2.1-vs10, C:\work\qt5.2.1-mingw.
62
63    4.  Download and install Perl from http://www.activestate.com/activeperl
64        and check that perl.exe is added to the path. Run perl -v to verify
65        that the version displayed is 5.10 or later. Note that git ships
66        an outdated version 5.8 which cannot be used for Qt.
67
68    5.  In the working directory, check out the respective branch of Qt
69        (we recommend the latest released version from the release branch,
70        5.2.1; see https://qt.gitorious.org/qt).
71
72    6.  Check out Qt Creator (master branch or latest version, see
73        https://qt.gitorious.org/qt-creator).
74        You should now have the directories qt and creator under your working
75        directory.
76
77    7.  Install a compiler:
78        - For a MinGW toolchain for Qt, see http://wiki.qt.io/MinGW .
79
80        - For Microsoft Visual C++, install the Windows SDK and the "Debugging
81          Tools for Windows" from the SDK image. We strongly recommend using the
82          64-bit version and 64-bit compilers on 64-bit systems.
83
84          When using Visual C++ 2010, you must apply a hotfix that is available
85          from http://support.microsoft.com/kb/2280741
86          (See https://bugreports.qt.io/browse/QTBUG-11445).
87
88          For the Visual C++ compilers, it is recommended to use the tool 'jom'.
89          It is a replacement for nmake that utilizes all CPU cores and thus
90          speeds up compilation significantly. Download it from
91          http://download.qt-project.org/official_releases/jom
92          and add the executable to the path.
93
94    8.  For convenience, we recommend creating shell prompts with the correct
95        environment. This can be done by creating a .bat-file
96        (such as, <working_directory>\qtvars.bat) that contains the environment
97        variable settings.
98        A .bat-file for MinGW looks like:
99
100          set PATH=<path_to_qt>\[qtbase\]bin;<path_to_mingw>\bin;<working_directory>\creator\bin;%PATH%
101          set QMAKESPEC=win32-g++
102
103        For the Visual C++ compilers, call the .bat file that sets up the
104        environment for the compiler (provided by the Windows SDK or the
105        compiler):
106
107          CALL "C:\Program Files (x86)\MSVC10\VC\vcvarsall.bat" amd64
108          set PATH=<path_to_qt>\[qtbase\]bin;<working_directory>\creator\bin;%PATH%
109          set QMAKESPEC=win32-msvc2010
110
111        You can create desktop links to the bat files using the working
112        directory and specifying
113
114        %SystemRoot%\system32\cmd.exe /E:ON /V:ON  /k <working_directory>\qtvars.bat
115
116    9.  When using MinGW, open the shell prompt and enter:
117
118        sh.exe
119
120        That should result in a 'sh is not recognized as internal or external
121        command...' error. If a sh.exe is found, the compile process will fail.
122        You have to remove it from the path.
123
124   10.  You are now ready to configure and build Qt and Qt Creator.
125        Please see http://wiki.qt.io/Building_Qt_5_from_Git for
126        recommended configure-options for Qt 5.
127        To use MinGW, open the the shell prompt and enter:
128
129          cd <path_to_qt>
130          configure <configure_options> && mingw32-make -s
131          cd ..\creator
132          qmake && mingw32-make -s
133
134        To use the Visual C++ compilers, enter:
135
136          cd <path_to_qt>
137          configure <configure_options> && jom
138          cd ..\creator
139          qmake && jom
140
141    11. To launch Qt Creator, enter:
142        qtcreator
143
144    12. When using  Visual C++ with the "Debugging Tools for Windows" installed,
145        the extension library qtcreatorcdbext.dll to be loaded into the
146        Windows console debugger (cdb.exe) should have been built under
147        lib\qtcreatorcdbext32 or lib\qtcreatorcdbext64.
148        When using a 32 bit-build of Qt Creator with the 64 bit version of the
149        "Debugging Tools for Windows" the library should also be built with
150        a 64 bit compiler (rebuild src\libs\qtcreatorcdbext using a 64 bit
151        compiler).
152
153        If you are building 32 bit and running on a 64 bit
154        Windows, you can obtain the 64 bit versions of the extension library
155        and the binary win64interrupt.exe, which is required for
156        debugging from the repository
157        https://qt.gitorious.org/qt-creator/binary-artifacts/source/ .
158
159    13. Qt Creator can be registered as a post-mortem debugger. This
160        can be done in the options page or by running the tool qtcdebugger
161        with administrative privileges passing the command line options
162        -register/unregister, respectively. Alternatively,
163        the required registry entries
164        HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug and
165        HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug
166        can be modified using the registry editor regedt32 to contain
167        <path>\qt-creator\bin\qtcdebugger %ld %ld
168
169        When using a self-built version of Qt Creator as post-mortem debugger, it needs to be
170        able to find all dependent Qt-libraries and plugins when being launched by the
171        system. The easiest way to provide them for Qt 5 is to run the tool windeployqt:
172
173        windeployqt -qmldir share\qtcreator -qmldir src\plugins\qmlprofiler bin\qtcreator.exe lib\qtcreator lib\qtcreator\plugins
174
175 Note that unlike on Unix, you cannot overwrite executables that are running.
176 Thus, if you want to work on Qt Creator using Qt Creator, you need a
177 separate build of it. We recommend using a separate, release-built version
178 of Qt and Qt Creator to work on a debug-built version of Qt and Qt Creator
179 or using shadow builds.
180
181 Third-party Components
182 ======================
183 Qt Creator includes the following third-party components,
184 we thank the authors who made this possible:
185
186 * Open Source front-end for C++ (license MIT), enhanced for use in Qt Creator
187
188   Roberto Raggi <roberto.raggi@gmail.com>
189
190   QtCreator/src/shared/cplusplus
191
192   Copyright 2005 Roberto Raggi <roberto@kdevelop.org>
193
194   Permission to use, copy, modify, distribute, and sell this software and its
195   documentation for any purpose is hereby granted without fee, provided that
196   the above copyright notice appear in all copies and that both that
197   copyright notice and this permission notice appear in supporting
198   documentation.
199
200   The above copyright notice and this permission notice shall be included in
201   all copies or substantial portions of the Software.
202
203   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
204   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
205   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
206   KDEVELOP TEAM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
207   AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
208   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
209
210
211 * Botan, a C++ crypto library. Version 1.10.2
212
213   Botan (http://botan.randombit.net/) is distributed under these terms::
214
215   Copyright (C) 1999-2011 Jack Lloyd
216                 2001 Peter J Jones
217                 2004-2007 Justin Karneges
218                 2004 Vaclav Ovsik
219                 2005 Matthew Gregan
220                 2005-2006 Matt Johnston
221                 2006 Luca Piccarreta
222                 2007 Yves Jerschow
223                 2007-2008 FlexSecure GmbH
224                 2007-2008 Technische Universitat Darmstadt
225                 2007-2008 Falko Strenzke
226                 2007-2008 Martin Doering
227                 2007 Manuel Hartl
228                 2007 Christoph Ludwig
229                 2007 Patrick Sona
230                 2010 Olivier de Gaalon
231   All rights reserved.
232
233   Redistribution and use in source and binary forms, with or without
234   modification, are permitted provided that the following conditions are
235   met:
236
237   1. Redistributions of source code must retain the above copyright
238   notice, this list of conditions, and the following disclaimer.
239
240   2. Redistributions in binary form must reproduce the above copyright
241   notice, this list of conditions, and the following disclaimer in the
242   documentation and/or other materials provided with the distribution.
243
244   THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) "AS IS" AND ANY EXPRESS OR
245   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
246   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
247   ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTOR(S) BE
248   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
249   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
250   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
251   BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
252   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
253   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
254   IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
255
256   The source code of Botan C++ crypto library can be found in
257   QtCreator/src/libs/3rdparty
258
259
260 * ClassView and ImageViewer plugins
261
262   Copyright (C) 2015 The Qt Company Ltd.
263
264   All rights reserved.
265   Copyright (C) 2015 Denis Mingulov.
266
267   Contact: http://www.qt.io
268
269   This file is part of Qt Creator.
270
271   You may use this file under the terms of the BSD license as follows:
272
273   "Redistribution and use in source and binary forms, with or without
274   modification, are permitted provided that the following conditions are
275   met:
276     * Redistributions of source code must retain the above copyright
277       notice, this list of conditions and the following disclaimer.
278     * Redistributions in binary form must reproduce the above copyright
279       notice, this list of conditions and the following disclaimer in
280       the documentation and/or other materials provided with the
281       distribution.
282     * Neither the name of The Qt Company Ltd and its Subsidiary(-ies) nor
283       the names of its contributors may be used to endorse or promote
284       products derived from this software without specific prior written
285       permission.
286
287   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
288   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
289   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
290   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
291   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
292   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
293   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
294   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
295   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
296   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
297   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
298
299
300