README.md 12.5 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

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.
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 19 20 21 22 23 24 25

* Qt 5.3.1 or later
* On Windows:
    * ActiveState Active Perl
    * MinGW with g++ 4.5 or Visual Studio 2010 or later
    * jom
* On Mac OS X: latest Xcode
* On Linux: g++ 4.5 or later
26 27

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

29
You can build Qt Creator with
30

31 32 33 34 35 36 37
    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
38

Eike Ziller's avatar
Eike Ziller committed
39
## Compiling Qt and Qt Creator on Windows
40 41 42 43

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

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

Eike Ziller's avatar
Eike Ziller committed
63 64
   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
65 66
       that the version displayed is 5.10 or later. Note that git ships
       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
Friedemann Kleint's avatar
Friedemann Kleint committed
69
       (we recommend the latest released version from the release branch,
Eike Ziller's avatar
Eike Ziller committed
70
       5.2.1; see <https://qt.gitorious.org/qt>).
71

Friedemann Kleint's avatar
Friedemann Kleint committed
72
   6.  Check out Qt Creator (master branch or latest version, see
Eike Ziller's avatar
Eike Ziller committed
73
       <https://qt.gitorious.org/qt-creator>).
74 75 76 77
       You should now have the directories qt and creator under your working
       directory.

   7.  Install a compiler:
Eike Ziller's avatar
Eike Ziller committed
78
       - For a MinGW toolchain for Qt, see <https://wiki.qt.io/MinGW> .
79 80 81 82 83 84

       - 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
Eike Ziller's avatar
Eike Ziller committed
85 86
         from `https://support.microsoft.com/kb/2280741`
         (see [QTBUG-11445](https://bugreports.qt.io/browse/QTBUG-11445)).
87 88 89 90

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

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

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

Eike Ziller's avatar
Eike Ziller committed
103
       For the Visual C++ compilers, call the `.bat` file that sets up the
104 105 106 107
       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
108
         set PATH=<path_to_qt>\[qtbase\]bin;<working_directory>\creator\bin;%PATH%
109 110
         set QMAKESPEC=win32-msvc2010

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

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

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

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

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

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

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

       To use the Visual C++ compilers, enter:

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

   11. To launch Qt Creator, enter:
       qtcreator

   12. When using  Visual C++ with the "Debugging Tools for Windows" installed,
Eike Ziller's avatar
Eike Ziller committed
145 146 147
       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`.
148 149
       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
150
       a 64 bit compiler (rebuild `src\libs\qtcreatorcdbext` using a 64 bit
151 152
       compiler).

Friedemann Kleint's avatar
Friedemann Kleint committed
153 154
       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
155
       and the binary `win64interrupt.exe`, which is required for
Friedemann Kleint's avatar
Friedemann Kleint committed
156
       debugging from the repository
Eike Ziller's avatar
Eike Ziller committed
157
       <https://qt.gitorious.org/qt-creator/binary-artifacts/source/> .
Friedemann Kleint's avatar
Friedemann Kleint committed
158 159 160 161 162 163

   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
Eike Ziller's avatar
Eike Ziller committed
164 165 166 167

        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
168
       can be modified using the registry editor regedt32 to contain
Eike Ziller's avatar
Eike Ziller committed
169 170

        <path>\qt-creator\bin\qtcdebugger %ld %ld
Friedemann Kleint's avatar
Friedemann Kleint committed
171 172 173 174 175

       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:

Eike Ziller's avatar
Eike Ziller committed
176
        windeployqt -qmldir share\qtcreator -qmldir src\plugins\qmlprofiler bin\qtcreator.exe lib\qtcreator lib\qtcreator\plugins
Friedemann Kleint's avatar
Friedemann Kleint committed
177

178 179 180 181 182 183
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
184 185
## Third-party Components

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

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

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

con's avatar
con committed
193 194
  QtCreator/src/shared/cplusplus

hjk's avatar
hjk committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
  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.


Eike Ziller's avatar
Eike Ziller committed
214
### Botan, a C++ crypto library. Version 1.10.2
Kai Koehne's avatar
Kai Koehne committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

  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
234 235 236
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
Kai Koehne's avatar
Kai Koehne committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
  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.
258 259 260 261

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

hjk's avatar
hjk committed
262

Eike Ziller's avatar
Eike Ziller committed
263
### ClassView and ImageViewer plugins
hjk's avatar
hjk committed
264

Eike Ziller's avatar
Eike Ziller committed
265
  Copyright (C) 2015 The Qt Company Ltd.
hjk's avatar
hjk committed
266 267

  All rights reserved.
Eike Ziller's avatar
Eike Ziller committed
268
  Copyright (C) 2015 Denis Mingulov.
hjk's avatar
hjk committed
269

Eike Ziller's avatar
Eike Ziller committed
270
  Contact: http://www.qt.io
hjk's avatar
hjk committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284

  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
285
    * Neither the name of The Qt Company Ltd and its Subsidiary(-ies) nor
hjk's avatar
hjk committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
      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."