README 13.7 KB
Newer Older
1 2
Qt Creator
==========
Kai Koehne's avatar
Kai Koehne committed
3
Qt Creator is a cross-platform IDE for development with the Qt framework.
con's avatar
con committed
4 5 6

Supported Platforms
===================
7
The standalone binary packages support the following platforms:
con's avatar
con committed
8

Friedemann Kleint's avatar
Friedemann Kleint committed
9
Windows XP SP3 or later
10
(K)Ubuntu Linux 11.10 (32-bit and 64-bit) or later
Eike Ziller's avatar
Eike Ziller committed
11
Mac OS X 10.7 or later
con's avatar
con committed
12

Friedemann Kleint's avatar
Friedemann Kleint committed
13
Building the sources requires Qt 5.3.1 or later.
14
It is also possible to build with Qt 4.8.x, but in that case the Welcome mode,
15
QML Profiler, and the WinRT and Qbs support are disabled.
con's avatar
con committed
16

con's avatar
con committed
17 18 19
Compiling Qt Creator
====================
Prerequisites:
Friedemann Kleint's avatar
Friedemann Kleint committed
20
   * Qt 5.3.1 or later (with restrictions also Qt 4.8.x)
21
   * On Windows:
22
     -  ActiveState Active Perl
23
     -  MinGW with g++ 4.5 or Visual Studio 2010 or later
24
     -  jom
Eike Ziller's avatar
Eike Ziller committed
25
   * On Mac OS X: latest Xcode
26
   * On Linux: g++ 4.5 or later
27 28

The installed toolchains have to match the one Qt was compiled with.
con's avatar
con committed
29

30
You can build Qt Creator with
31

32 33 34 35
    cd $SOURCE_DIRECTORY
    qmake -r
    make (or mingw32-make or nmake or jom, depending on your platform)

Eike Ziller's avatar
Eike Ziller committed
36 37
Note: If you use Qt 4.8 to build on OS X, you need to additionally pass
      "-spec unsupported/macx-clang-libc++" to qmake.
38

39 40 41
Installation ("make install") is not needed. It is however possible, using

    make install INSTALL_ROOT=$INSTALL_DIRECTORY
con's avatar
con committed
42

Eike Ziller's avatar
Eike Ziller committed
43 44
Private Header Dependencies When Compiling With Qt 4.8
------------------------------------------------------
45

Eike Ziller's avatar
Eike Ziller committed
46
The QNX plugin, and on Windows the Utils library, use
47 48 49 50 51 52
private headers of Qt. These private headers always end with an "_p.h". Digia
and the Qt Project do not promise to keep these files or APIs binary or source
compatible between releases. This means that when compiled, Qt Creator has a
dependency to the exact Qt version it was compiled with. Running Qt Creator
against updated Qt libraries (also for patch releases) might lead to link time
failures, or even crashes.
53

Friedemann Kleint's avatar
Friedemann Kleint committed
54
To disable the plugins, pass "QT_PRIVATE_HEADERS=" to qmake:
55 56 57

  qmake "QT_PRIVATE_HEADERS=" $SOURCE_DIRECTORY/qtcreator.pro

58 59 60 61 62 63
Compiling Qt and Qt Creator on Windows
--------------------------------------

This section provides step by step instructions for compiling the latest
versions of Qt and Qt Creator on Windows. Alternatively, to avoid having to
compile Qt yourself, you can use one of the versions of Qt shipped with the Qt
Friedemann Kleint's avatar
Friedemann Kleint committed
64 65 66
SDK (release builds of Qt using MinGW and Visual C++ 2010 or later).
For detailed information on the supported compilers, see
http://qt-project.org/wiki/Building_Qt_5_from_Git .
67 68 69 70 71 72 73 74 75 76 77 78 79 80

   1.  Decide which compiler to use: MinGW or Microsoft Visual Studio. If you
       plan to contribute to Qt Creator, you should compile your changes with
       both compilers.

   2.  Install msysGit from http://code.google.com/p/msysgit/. If you plan to
       use the MinGW compiler suite, do not choose to put git in the
       default path of Windows command prompts. For more information, see
       step 9.

   3.  Create a working directory under which to check out Qt and Qt Creator,
       for example, c:\work. If you plan to use MinGW and Microsoft Visual
       Studio simultaneously or mix different Qt versions, we recommend
       creating a directory structure which reflects that. For example:
Friedemann Kleint's avatar
Friedemann Kleint committed
81
       C:\work\qt5.2.1-vs10, C:\work\qt5.2.1-mingw.
82 83

   4.  Download and install Perl from http://www.activestate.com/activeperl
Friedemann Kleint's avatar
Friedemann Kleint committed
84 85 86
       and check that perl.exe is added to the path. Run perl -v to verify
       that the version displayed is 5.10 or later. Note that git ships
       an outdated version 5.8 which cannot be used for Qt.
87 88

   5.  In the working directory, check out the respective branch of Qt
Friedemann Kleint's avatar
Friedemann Kleint committed
89 90
       (we recommend the latest released version from the release branch,
       5.2.1; see https://qt.gitorious.org/qt).
91

Friedemann Kleint's avatar
Friedemann Kleint committed
92 93
   6.  Check out Qt Creator (master branch or latest version, see
       https://qt.gitorious.org/qt-creator).
94 95 96 97
       You should now have the directories qt and creator under your working
       directory.

   7.  Install a compiler:
Friedemann Kleint's avatar
Friedemann Kleint committed
98
       - For a MinGW toolchain for Qt, see http://qt-project.org/wiki/MinGW .
99 100 101 102 103 104 105

       - For Microsoft Visual C++, install the Windows SDK and the "Debugging
         Tools for Windows" from the SDK image. We strongly recommend using the
         64-bit version and 64-bit compilers on 64-bit systems.

         When using Visual C++ 2010, you must apply a hotfix that is available
         from http://support.microsoft.com/kb/2280741
106
         (See https://bugreports.qt-project.org/browse/QTBUG-11445).
107 108 109 110

         For the Visual C++ compilers, it is recommended to use the tool 'jom'.
         It is a replacement for nmake that utilizes all CPU cores and thus
         speeds up compilation significantly. Download it from
Friedemann Kleint's avatar
Friedemann Kleint committed
111 112
         http://download.qt-project.org/official_releases/jom
         and add the executable to the path.
113 114 115 116 117 118 119

   8.  For convenience, we recommend creating shell prompts with the correct
       environment. This can be done by creating a .bat-file
       (such as, <working_directory>\qtvars.bat) that contains the environment
       variable settings.
       A .bat-file for MinGW looks like:

Friedemann Kleint's avatar
Friedemann Kleint committed
120
         set PATH=<path_to_qt>\[qtbase\]bin;<path_to_mingw>\bin;<working_directory>\creator\bin;%PATH%
121 122 123 124 125 126 127
         set QMAKESPEC=win32-g++

       For the Visual C++ compilers, call the .bat file that sets up the
       environment for the compiler (provided by the Windows SDK or the
       compiler):

         CALL "C:\Program Files (x86)\MSVC10\VC\vcvarsall.bat" amd64
Friedemann Kleint's avatar
Friedemann Kleint committed
128
         set PATH=<path_to_qt>\[qtbase\]bin;<working_directory>\creator\bin;%PATH%
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
         set QMAKESPEC=win32-msvc2010

       You can create desktop links to the bat files using the working
       directory and specifying

       %SystemRoot%\system32\cmd.exe /E:ON /V:ON  /k <working_directory>\qtvars.bat

   9.  When using MinGW, open the shell prompt and enter:

       sh.exe

       That should result in a 'sh is not recognized as internal or external
       command...' error. If a sh.exe is found, the compile process will fail.
       You have to remove it from the path.

  10.  You are now ready to configure and build Qt and Qt Creator.
Friedemann Kleint's avatar
Friedemann Kleint committed
145 146
       Please see http://qt-project.org/wiki/Building_Qt_5_from_Git for
       recommended configure-options for Qt 5.
147 148
       To use MinGW, open the the shell prompt and enter:

Friedemann Kleint's avatar
Friedemann Kleint committed
149 150
         cd <path_to_qt>
         configure <configure_options> && mingw32-make -s
151 152 153 154 155
         cd ..\creator
         qmake && mingw32-make -s

       To use the Visual C++ compilers, enter:

Friedemann Kleint's avatar
Friedemann Kleint committed
156 157
         cd <path_to_qt>
         configure <configure_options> && jom
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
         cd ..\creator
         qmake && jom

   11. To launch Qt Creator, enter:
       qtcreator

   12. When using  Visual C++ with the "Debugging Tools for Windows" installed,
       the extension library qtcreatorcdbext.dll to be loaded into the
       Windows console debugger (cdb.exe) should have been built under
       lib\qtcreatorcdbext32 or lib\qtcreatorcdbext64.
       When using a 32 bit-build of Qt Creator with the 64 bit version of the
       "Debugging Tools for Windows" the library should also be built with
       a 64 bit compiler (rebuild src\libs\qtcreatorcdbext using a 64 bit
       compiler).

Friedemann Kleint's avatar
Friedemann Kleint committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
       If you are building 32 bit and running on a 64 bit
       Windows, you can obtain the 64 bit versions of the extension library
       and the binary win64interrupt.exe, which is required for
       debugging from the repository
       https://qt.gitorious.org/qt-creator/binary-artifacts/source/ .

   13. Qt Creator can be registered as a post-mortem debugger. This
       can be done in the options page or by running the tool qtcdebugger
       with administrative privileges passing the command line options
       -register/unregister, respectively. Alternatively,
       the required registry entries
       HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug and
       HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug
       can be modified using the registry editor regedt32 to contain
       <path>\qt-creator\bin\qtcdebugger %ld %ld

       When using a self-built version of Qt Creator as post-mortem debugger, it needs to be
       able to find all dependent Qt-libraries and plugins when being launched by the
       system. The easiest way to provide them for Qt 5 is to run the tool windeployqt:

Friedemann Kleint's avatar
Friedemann Kleint committed
193
       windeployqt -svg -xml -designercomponents -script -concurrent -network -quick -quickwidgets -test -sql -printsupport -qthelp -qmldir share\qtcreator -qmldir src\plugins\qmlprofiler bin\qtcreator.exe
Friedemann Kleint's avatar
Friedemann Kleint committed
194

195 196 197 198 199 200 201
Note that unlike on Unix, you cannot overwrite executables that are running.
Thus, if you want to work on Qt Creator using Qt Creator, you need a
separate build of it. We recommend using a separate, release-built version
of Qt and Qt Creator to work on a debug-built version of Qt and Qt Creator
or using shadow builds.

Third-party Components
con's avatar
con committed
202
======================
Kai Koehne's avatar
Kai Koehne committed
203
Qt Creator includes the following third-party components,
con's avatar
con committed
204 205 206
we thank the authors who made this possible:

* Open Source front-end for C++ (license MIT), enhanced for use in Qt Creator
207

con's avatar
con committed
208
  Roberto Raggi <roberto.raggi@gmail.com>
hjk's avatar
hjk committed
209

con's avatar
con committed
210 211
  QtCreator/src/shared/cplusplus

hjk's avatar
hjk committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
  Copyright 2005 Roberto Raggi <roberto@kdevelop.org>

  Permission to use, copy, modify, distribute, and sell this software and its
  documentation for any purpose is hereby granted without fee, provided that
  the above copyright notice appear in all copies and that both that
  copyright notice and this permission notice appear in supporting
  documentation.

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  KDEVELOP TEAM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Kai Koehne's avatar
Kai Koehne committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
* Botan, a C++ crypto library. Version 1.10.2

  Botan (http://botan.randombit.net/) is distributed under these terms::

  Copyright (C) 1999-2011 Jack Lloyd
                2001 Peter J Jones
                2004-2007 Justin Karneges
                2004 Vaclav Ovsik
                2005 Matthew Gregan
                2005-2006 Matt Johnston
                2006 Luca Piccarreta
                2007 Yves Jerschow
                2007-2008 FlexSecure GmbH
                2007-2008 Technische Universitat Darmstadt
                2007-2008 Falko Strenzke
                2007-2008 Martin Doering
                2007 Manuel Hartl
                2007 Christoph Ludwig
                2007 Patrick Sona
                2010 Olivier de Gaalon
251 252 253
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
Kai Koehne's avatar
Kai Koehne committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
  modification, are permitted provided that the following conditions are
  met:

  1. Redistributions of source code must retain the above copyright
  notice, this list of conditions, and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions, and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

  THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) "AS IS" AND ANY EXPRESS OR
  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
  ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTOR(S) BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
275 276 277 278

  The source code of Botan C++ crypto library can be found in
  QtCreator/src/libs/3rdparty

hjk's avatar
hjk committed
279 280 281

* ClassView and ImageViewer plugins

282
  Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
283 284

  All rights reserved.
285
  Copyright (c) 2014 Denis Mingulov.
hjk's avatar
hjk committed
286

Eike Ziller's avatar
Eike Ziller committed
287
  Contact: http://www.qt-project.org/
hjk's avatar
hjk committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301

  This file is part of Qt Creator.

  You may use this file under the terms of the BSD license as follows:

  "Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
hjk's avatar
hjk committed
302
    * Neither the name of Digia Plc and its Subsidiary(-ies) nor
hjk's avatar
hjk committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
      the names of its contributors may be used to endorse or promote
      products derived from this software without specific prior written
      permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."