README.md 14.3 KB
Newer Older
Eike Ziller's avatar
Eike Ziller committed
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

Eike Ziller's avatar
Eike Ziller committed
5 6
## Supported Platforms

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

9 10
Windows 7 or later
(K)Ubuntu Linux 14.04 (64-bit) or later
11
macOS 10.8 or later
con's avatar
con committed
12

hjk's avatar
hjk committed
13
Building the sources requires Qt 5.5.0 or later.
con's avatar
con committed
14

Eike Ziller's avatar
Eike Ziller committed
15 16
## Compiling Qt Creator

con's avatar
con committed
17
Prerequisites:
Eike Ziller's avatar
Eike Ziller committed
18

hjk's avatar
hjk committed
19
* Qt 5.5.0 or later
Eike Ziller's avatar
Eike Ziller committed
20 21
* On Windows:
    * ActiveState Active Perl
22
    * MinGW with g++ 4.7 or Visual Studio 2013 Update 2 or later
Eike Ziller's avatar
Eike Ziller committed
23 24
    * jom
* On Mac OS X: latest Xcode
25
* On Linux: g++ 4.7 or later
26
* LLVM 3.8.0 or later (optional, needed for the Clang Code Model)
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
    # Optional, needed for the Clang Code Model:
    export LLVM_INSTALL_DIR=/path/to/llvm (or "set" on Windows)

35 36 37 38 39 40 41
    cd $SOURCE_DIRECTORY
    qmake -r
    make (or mingw32-make or nmake or jom, depending on your platform)

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
## Compiling Qt and Qt Creator on Windows
44 45 46 47

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
48
SDK (release builds of Qt using MinGW and Visual C++ 2013 or later).
Friedemann Kleint's avatar
Friedemann Kleint committed
49
For detailed information on the supported compilers, see
Eike Ziller's avatar
Eike Ziller committed
50
<https://wiki.qt.io/Building_Qt_5_from_Git> .
51 52 53 54 55

   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.

Eike Ziller's avatar
Eike Ziller committed
56
   2.  Install msysGit from <https://msysgit.github.io/>. If you plan to
57 58 59 60 61
       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,
Eike Ziller's avatar
Eike Ziller committed
62
       for example, `c:\work`. If you plan to use MinGW and Microsoft Visual
63 64
       Studio simultaneously or mix different Qt versions, we recommend
       creating a directory structure which reflects that. For example:
hjk's avatar
hjk committed
65
       `C:\work\qt5.5.1-vs12, C:\work\qt5.5.1-mingw`.
66

Eike Ziller's avatar
Eike Ziller committed
67 68
   4.  Download and install Perl from <https://www.activestate.com/activeperl>
       and check that perl.exe is added to the path. Run `perl -v` to verify
Friedemann Kleint's avatar
Friedemann Kleint committed
69 70
       that the version displayed is 5.10 or later. Note that git ships
       an outdated version 5.8 which cannot be used for Qt.
71

Eike Ziller's avatar
Eike Ziller committed
72 73
   5.  In the working directory, check out the respective branch of Qt from
       <https://code.qt.io/cgit/qt/qt5.git> (we recommend the latest released version).
74

Friedemann Kleint's avatar
Friedemann Kleint committed
75
   6.  Check out Qt Creator (master branch or latest version, see
Eike Ziller's avatar
Eike Ziller committed
76
       <https://code.qt.io/cgit/qt-creator/qt-creator.git>).
77 78 79 80
       You should now have the directories qt and creator under your working
       directory.

   7.  Install a compiler:
Eike Ziller's avatar
Eike Ziller committed
81
       - For a MinGW toolchain for Qt, see <https://wiki.qt.io/MinGW> .
82 83 84 85 86 87 88 89

       - 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.

         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
Eike Ziller's avatar
Eike Ziller committed
90
         <https://download.qt.io/official_releases/jom>
Friedemann Kleint's avatar
Friedemann Kleint committed
91
         and add the executable to the path.
92 93 94

   8.  For convenience, we recommend creating shell prompts with the correct
       environment. This can be done by creating a .bat-file
Eike Ziller's avatar
Eike Ziller committed
95
       (such as, `<working_directory>\qtvars.bat`) that contains the environment
96
       variable settings.
Eike Ziller's avatar
Eike Ziller committed
97
       A `.bat`-file for MinGW looks like:
98

Friedemann Kleint's avatar
Friedemann Kleint committed
99
         set PATH=<path_to_qt>\[qtbase\]bin;<path_to_mingw>\bin;<working_directory>\creator\bin;%PATH%
100 101
         set QMAKESPEC=win32-g++

Eike Ziller's avatar
Eike Ziller committed
102
       For the Visual C++ compilers, call the `.bat` file that sets up the
103 104 105
       environment for the compiler (provided by the Windows SDK or the
       compiler):

106
         CALL "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" amd64
Friedemann Kleint's avatar
Friedemann Kleint committed
107
         set PATH=<path_to_qt>\[qtbase\]bin;<working_directory>\creator\bin;%PATH%
108
         set QMAKESPEC=win32-msvc2013
109

Eike Ziller's avatar
Eike Ziller committed
110
       You can create desktop links to the `.bat` files using the working
111 112
       directory and specifying

Eike Ziller's avatar
Eike Ziller committed
113
        %SystemRoot%\system32\cmd.exe /E:ON /V:ON  /k <working_directory>\qtvars.bat
114 115 116

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

Eike Ziller's avatar
Eike Ziller committed
117
        sh.exe
118

Eike Ziller's avatar
Eike Ziller committed
119 120
       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.
121 122
       You have to remove it from the path.

123
  10.  To enable the Clang-based code model: Install Clang (>= version 3.8.0)
124 125 126 127
       and set the environment variable LLVM_INSTALL_DIR to point to the
       installation location.

  11.  You are now ready to configure and build Qt and Qt Creator.
Eike Ziller's avatar
Eike Ziller committed
128
       Please see <https://wiki.qt.io/Building_Qt_5_from_Git> for
Friedemann Kleint's avatar
Friedemann Kleint committed
129
       recommended configure-options for Qt 5.
130 131
       To use MinGW, open the the shell prompt and enter:

Friedemann Kleint's avatar
Friedemann Kleint committed
132 133
         cd <path_to_qt>
         configure <configure_options> && mingw32-make -s
134 135 136 137 138
         cd ..\creator
         qmake && mingw32-make -s

       To use the Visual C++ compilers, enter:

Friedemann Kleint's avatar
Friedemann Kleint committed
139 140
         cd <path_to_qt>
         configure <configure_options> && jom
141 142 143
         cd ..\creator
         qmake && jom

144
   12. To launch Qt Creator, enter:
145 146
       qtcreator

147 148 149 150 151 152 153 154
   13. To test the Clang-based code model, verify that backend process
         bin\clangbackend.exe
       launches (displaying its usage).

       The library libclang.dll needs to be copied to the bin directory if
       Clang cannot be found in the path.

   14. When using  Visual C++ with the "Debugging Tools for Windows" installed,
Eike Ziller's avatar
Eike Ziller committed
155 156 157
       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`.
158 159
       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
Eike Ziller's avatar
Eike Ziller committed
160
       a 64 bit compiler (rebuild `src\libs\qtcreatorcdbext` using a 64 bit
161 162
       compiler).

Friedemann Kleint's avatar
Friedemann Kleint committed
163 164
       If you are building 32 bit and running on a 64 bit
       Windows, you can obtain the 64 bit versions of the extension library
Eike Ziller's avatar
Eike Ziller committed
165
       and the binary `win64interrupt.exe`, which is required for
Friedemann Kleint's avatar
Friedemann Kleint committed
166
       debugging from the repository
Eike Ziller's avatar
Eike Ziller committed
167
       <https://code.qt.io/cgit/qt-creator/binary-artifacts.git/tree> .
Friedemann Kleint's avatar
Friedemann Kleint committed
168

169
   15. Qt Creator can be registered as a post-mortem debugger. This
Friedemann Kleint's avatar
Friedemann Kleint committed
170 171 172 173
       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
Eike Ziller's avatar
Eike Ziller committed
174 175 176 177

        HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug
        HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug

Friedemann Kleint's avatar
Friedemann Kleint committed
178
       can be modified using the registry editor regedt32 to contain
Eike Ziller's avatar
Eike Ziller committed
179 180

        <path>\qt-creator\bin\qtcdebugger %ld %ld
Friedemann Kleint's avatar
Friedemann Kleint committed
181 182 183 184 185

       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:

186
        windeployqt -quick -qmldir share\qtcreator\welcomescreen -qmldir src\plugins\qmlprofiler bin\qtcreator.exe lib\qtcreator lib\qtcreator\plugins
Friedemann Kleint's avatar
Friedemann Kleint committed
187

188 189 190 191 192 193
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.

Eike Ziller's avatar
Eike Ziller committed
194 195
## Third-party Components

Kai Koehne's avatar
Kai Koehne committed
196
Qt Creator includes the following third-party components,
con's avatar
con committed
197 198
we thank the authors who made this possible:

Eike Ziller's avatar
Eike Ziller committed
199
### Open Source front-end for C++ (license MIT), enhanced for use in Qt Creator
200

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

con's avatar
con committed
203 204
  QtCreator/src/shared/cplusplus

hjk's avatar
hjk committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  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.

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
### Open Source tool for generating C++ code that classifies keywords (license MIT)

  Roberto Raggi <roberto.raggi@gmail.com>

  QtCreator/src/tools/3rdparty/cplusplus-keywordgen

  Copyright (c) 2007 Roberto Raggi <roberto.raggi@gmail.com>

  Permission is hereby granted, free of charge, to any person obtaining a copy of
  this software and associated documentation files (the "Software"), to deal in
  the Software without restriction, including without limitation the rights to
  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  the Software, and to permit persons to whom the Software is furnished to do so,
  subject to the following conditions:

  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 AUTHORS OR
  COPYRIGHT HOLDERS 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.
hjk's avatar
hjk committed
247

Eike Ziller's avatar
Eike Ziller committed
248
### Botan, a C++ crypto library. Version 1.10.2
Kai Koehne's avatar
Kai Koehne committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

  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
268 269 270
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
Kai Koehne's avatar
Kai Koehne committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
  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.
292 293 294 295

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

296 297 298
### SQLite, in-process library that implements a SQL database engine

SQLite (https://www.sqlite.org) is in the Public Domain.
hjk's avatar
hjk committed
299

Eike Ziller's avatar
Eike Ziller committed
300
### ClassView and ImageViewer plugins
hjk's avatar
hjk committed
301

302
  Copyright (C) 2016 The Qt Company Ltd.
hjk's avatar
hjk committed
303 304

  All rights reserved.
305
  Copyright (C) 2016 Denis Mingulov.
hjk's avatar
hjk committed
306

Eike Ziller's avatar
Eike Ziller committed
307
  Contact: http://www.qt.io
hjk's avatar
hjk committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321

  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.
Eike Ziller's avatar
Eike Ziller committed
322
    * Neither the name of The Qt Company Ltd and its Subsidiary(-ies) nor
hjk's avatar
hjk committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
      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."