README.md 18.2 KB
Newer Older
Eike Ziller's avatar
Eike Ziller committed
1 2
# Qt Creator

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
* Windows 7 or later
10
* (K)Ubuntu Linux 16.04 (64-bit) or later
11
* macOS 10.10 or later
con's avatar
con committed
12

Eike Ziller's avatar
Eike Ziller committed
13 14
## Compiling Qt Creator

con's avatar
con committed
15
Prerequisites:
Eike Ziller's avatar
Eike Ziller committed
16

17
* Qt 5.6.2 or later
18
* Qt WebEngine module for QtWebEngine based help viewer
Eike Ziller's avatar
Eike Ziller committed
19 20
* On Windows:
    * ActiveState Active Perl
21
    * MinGW with g++ 4.9 or Visual Studio 2015 or later
Eike Ziller's avatar
Eike Ziller committed
22 23
    * jom
* On Mac OS X: latest Xcode
24
* On Linux: g++ 4.9 or later
25
* LLVM/Clang 5.0.0 or later (optional, needed for the Clang Code Model, see the
26 27
  section "Get LLVM/Clang for the Clang Code Model")
    * CMake (only for manual builds of LLVM/Clang)
28
* Qbs 1.7.x (optional, sources also contain Qbs itself)
29 30

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

32
You can build Qt Creator with
33

34
    # Optional, needed for the Clang Code Model if llvm-config is not in PATH:
35
    export LLVM_INSTALL_DIR=/path/to/llvm (or "set" on Windows)
36 37
    # Optional, needed to let the QbsProjectManager plugin use system Qbs:
    export QBS_INSTALL_DIR=/path/to/qbs
38

39 40 41 42 43 44 45
    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
46

Eike Ziller's avatar
Eike Ziller committed
47
## Compiling Qt and Qt Creator on Windows
48 49 50 51

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

   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.

60
   2.  Install Git for Windows from <https://git-for-windows.github.io/>. If you plan to
61 62 63 64 65
       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
66
       for example, `c:\work`. If you plan to use MinGW and Microsoft Visual
67 68
       Studio simultaneously or mix different Qt versions, we recommend
       creating a directory structure which reflects that. For example:
69
       `C:\work\qt5.6.0-vs12, C:\work\qt5.6.0-mingw`.
70

Eike Ziller's avatar
Eike Ziller committed
71 72
   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
73 74
       that the version displayed is 5.10 or later. Note that git ships
       an outdated version 5.8 which cannot be used for Qt.
75

Eike Ziller's avatar
Eike Ziller committed
76 77
   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).
78

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

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

       - 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
94
         <https://download.qt.io/official_releases/jom>
95
         and add the executable to the path.
96 97 98

   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
99
       (such as, `<working_directory>\qtvars.bat`) that contains the environment
100
       variable settings.
Eike Ziller's avatar
Eike Ziller committed
101
       A `.bat`-file for MinGW looks like:
102

103
         set PATH=<path_to_qt>\[qtbase\]bin;<path_to_mingw>\bin;<working_directory>\creator\bin;%PATH%
104 105
         set QMAKESPEC=win32-g++

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

110
         CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64
111
         set PATH=<path_to_qt>\[qtbase\]bin;<working_directory>\creator\bin;%PATH%
112
         set QMAKESPEC=win32-msvc2013
113

Eike Ziller's avatar
Eike Ziller committed
114
       You can create desktop links to the `.bat` files using the working
115 116
       directory and specifying

Eike Ziller's avatar
Eike Ziller committed
117
        %SystemRoot%\system32\cmd.exe /E:ON /V:ON  /k <working_directory>\qtvars.bat
118 119 120

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

Eike Ziller's avatar
Eike Ziller committed
121
        sh.exe
122

Eike Ziller's avatar
Eike Ziller committed
123 124
       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.
125 126
       You have to remove it from the path.

127 128 129 130 131
   10. To make use of the Clang Code Model:

       * Install LLVM/Clang - see the section "Get LLVM/Clang for the Clang
         Code Model".
       * Set the environment variable LLVM_INSTALL_DIR to the LLVM/Clang
132
         installation directory if llvm-config is not in PATH.
133 134 135 136
       * When you launch Qt Creator, activate the Clang Code Model plugin as
         described in doc/src/editors/creator-clang-codemodel.qdoc.

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

141 142
         cd <path_to_qt>
         configure <configure_options> && mingw32-make -s
143 144 145 146 147
         cd ..\creator
         qmake && mingw32-make -s

       To use the Visual C++ compilers, enter:

148 149
         cd <path_to_qt>
         configure <configure_options> && jom
150 151 152
         cd ..\creator
         qmake && jom

153
   12. To launch Qt Creator, enter:
154 155
       qtcreator

156 157 158 159 160 161 162 163
   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
164 165 166
       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`.
167 168
       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
169
       a 64 bit compiler (rebuild `src\libs\qtcreatorcdbext` using a 64 bit
170 171
       compiler).

172 173
       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
174
       and the binary `win64interrupt.exe`, which is required for
175
       debugging from the repository
Eike Ziller's avatar
Eike Ziller committed
176
       <https://code.qt.io/cgit/qt-creator/binary-artifacts.git/tree> .
177

178
   15. Qt Creator can be registered as a post-mortem debugger. This
179 180 181 182
       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
183 184 185 186

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

187
       can be modified using the registry editor regedt32 to contain
Eike Ziller's avatar
Eike Ziller committed
188 189

        <path>\qt-creator\bin\qtcdebugger %ld %ld
190 191 192 193 194

       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:

195
        windeployqt -quick -qmldir share\qtcreator\welcomescreen -qmldir src\plugins\qmlprofiler bin\qtcreator.exe lib\qtcreator lib\qtcreator\plugins
196

197 198 199 200 201 202
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.

203 204 205
## Get LLVM/Clang for the Clang Code Model

The Clang Code Model depends on the LLVM/Clang libraries. The currently
206
supported LLVM/Clang version is 5.0.
207 208 209 210 211 212 213 214 215 216 217 218

### Prebuilt LLVM/Clang packages

Prebuilt packages of LLVM/Clang can be downloaded from

    https://download.qt.io/development_releases/prebuilt/libclang/

This should be your preferred option because you will use the version that is
shipped together with Qt Creator. In addition, the packages for Windows are
faster due to profile-guided optimization. If the prebuilt packages do not
match your configuration, you need to build LLVM/Clang manually.

219 220 221 222 223 224 225 226
If you use GCC 5 or higher on Linux, please do not use our LLVM package, but get
the package for your distribution. Our LLVM package is compiled with GCC 4, so
you get linking errors, because GCC 5 is using a C++ 11 conforming string
implementation, which is not used by GCC 4. To sum it up, do not mix GCC 5 and
GCC 4 binaries. On Ubuntu, you can download the package from
http://apt.llvm.org/ with:

   wget -O - http://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
227
   sudo apt-add-repository "deb http://apt.llvm.org/`lsb_release -cs`/ llvm-toolchain-`lsb_release -cs`-5.0 main"
228
   sudo apt-get update
229
   sudo apt-get install llvm-5.0 libclang-5.0-dev
230 231 232 233 234 235

There is a workaround to set _GLIBCXX_USE_CXX11_ABI to 1 or 0, but we recommend
to download the package from http://apt.llvm.org/.

   https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html

236 237 238 239 240 241 242 243 244
### Building LLVM/Clang manually

You need to install CMake in order to build LLVM/Clang.

Build LLVM/Clang by roughly following the instructions at
http://llvm.org/docs/GettingStarted.html#git-mirror:

   1. Clone LLVM and switch to a suitable branch

245
          git clone https://git.llvm.org/git/llvm.git/
246 247 248 249 250 251
          cd llvm
          git checkout release_39

   2. Clone Clang into llvm/tools/clang and switch to a suitable branch

          cd tools
252
          git clone https://git.llvm.org/git/clang.git/
253 254 255 256 257 258 259 260 261 262 263
          cd clang
          git checkout release_39

   3. Build and install LLVM/Clang

          cd ../../..
          mkdir build
          cd build

      For Linux/macOS:

264
          cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<installation location> -DLLVM_ENABLE_RTTI=ON ../llvm
265 266 267 268 269 270 271
          make install

      For Windows:

          cmake -G "NMake Makefiles JOM" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<installation location> -DLLVM_ENABLE_RTTI=ON ..\llvm
          jom install

Eike Ziller's avatar
Eike Ziller committed
272 273
## Third-party Components

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

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
### Reference implementation for std::experimental::optional

  https://github.com/akrzemi1/Optional

  QtCreator/src/libs/3rdparty/optional

  Copyright (C) 2011-2012 Andrzej Krzemienski

  Distributed under the Boost Software License, Version 1.0
  (see accompanying file LICENSE_1_0.txt or a copy at
  http://www.boost.org/LICENSE_1_0.txt)

  The idea and interface is based on Boost.Optional library
  authored by Fernando Luis Cacciola Carballal

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

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

con's avatar
con committed
296 297
  QtCreator/src/shared/cplusplus

hjk's avatar
hjk committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
  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.

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
### 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
340

Eike Ziller's avatar
Eike Ziller committed
341
### Botan, a C++ crypto library. Version 1.10.2
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

  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
361 362 363
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
  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.
385 386 387 388

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

389 390 391
### 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
392

Eike Ziller's avatar
Eike Ziller committed
393
### ClassView and ImageViewer plugins
hjk's avatar
hjk committed
394

395
  Copyright (C) 2016 The Qt Company Ltd.
hjk's avatar
hjk committed
396 397

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

Eike Ziller's avatar
Eike Ziller committed
400
  Contact: http://www.qt.io
hjk's avatar
hjk committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414

  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
415
    * Neither the name of The Qt Company Ltd and its Subsidiary(-ies) nor
hjk's avatar
hjk committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
      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."
431 432 433 434 435 436 437 438 439 440 441 442

### Source Code Pro font

  Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
  with Reserved Font Name 'Source'. All Rights Reserved. Source is a
  trademark of Adobe Systems Incorporated in the United States
  and/or other countries.

  This Font Software is licensed under the SIL Open Font License, Version 1.1.

  The font and license files can be found in QtCreator/src/libs/3rdparty/fonts.