Building Qt Creator from Git: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
(Simplify page to actually only refer to the README.md for detailed instructions.)
Line 3: Line 3:
[[Category:Tools::QtCreator]]
[[Category:Tools::QtCreator]]


==Dependencies==
==Getting the source code==
 
Please also read [http://code.qt.io/cgit/qt-creator/qt-creator.git/tree/README.md README.md] in the source tree.
 
To build Qt Creator from git, you need to first prepare some dependencies:


*Qt libraries from Qt 5.14.0 (or newer) are needed. You can use one of the prebuilt packages from [http://qt.io/download the Downloads Page], or, if you want to go with git all the way, [http://wiki.qt.io/Building_Qt_5_from_Git compile Qt 5 from git] . These Qt modules are required: qtscript, qttools and qtdeclarative.
Qt Creator is open source. The arguably most convenient way to get the Qt Creator sources is with [https://git-scm.com/ Git].
*Optional: LLVM/Clang 6.0.0 or newer for the Clang Code Model related plugins. You might want to use one of the [https://ftp.fau.de/qtproject/development_releases/prebuilt/libclang/ prebuilt binaries].


If you have Qt installed, you probably have all the other dependencies of Qt Creator, too. There are numerous Qt Creator plugins, and they may require additional packages to be installed (but they usually don't block the compilation, so don't worry).
To get Qt Creator source code from git, you need first to install a [https://git-scm.com/downloads git client].


==Getting the source code==
If you have the git command client installed, you can then check out the sources from a terminal:


To get Qt Creator source code, use the following command in terminal:
<pre>
<pre>
git clone --recursive https://code.qt.io/qt-creator/qt-creator.git
git clone --recursive https://code.qt.io/qt-creator/qt-creator.git
</pre>
</pre>


N.B. If you do not want to include the Qbs plugin, you'll need to omit '''--recursive''' from the above command.
This will check out the latest development version of Qt Creator in a qt-creator directory. If you are interested in using other branches of the Qt Creator repository, please see the Qt Creator section at [http://wiki.qt.io/Branches Branch Guidelines].
 
This should be enough to compile Qt Creator from source. If you are interested in using other branches of the Qt Creator repository, please see the Qt Creator section at [http://wiki.qt.io/Branches Branch Guidelines].
 
==Compiling Qt Creator==
 
For building Qt Creator, an out-of-source build is recommended. For simplicity, this tutorial gives instructions for a build directory (namely 'qt-creator-build') that is located in parallel to the source directory ('qt-creator'), but any other folder can be used. If you have checked out '''Qbs''', it will be compiled together with the rest of the code, you do not need to do anything special.
 
Before you start with building, make sure you are using correct version of Qt. This can be done with the following command:
<pre>
qmake -v
</pre>
 
If the output points to a wrong version of Qt, or returns an error, you need to show the qmake binary to your environment (it may also mean that something is wrong with your Qt installation). You need to modify your PATH environment variable to include the directory with the qmake executable, e.g. <Qt installation directory>/qtbase/bin.
 
In order to build the optional Clang Code Model plugin, you need to provide the path to the LLVM installation directory:
 
<pre>
export LLVM_INSTALL_DIR=/path/to/llvm (or "set" on Windows)
</pre>
 
Prepare the Makefile:
 
<pre>
mkdir qt-creator-build
cd qt-creator-build
qmake ../qt-creator/qtcreator.pro
</pre>
 
'''Note:''' Your build directory must be on the same path hierarchy level as your source directory. Other configurations are not supported by qmake in all cases. If you do not heed that rule, your Qt Creator build will fail to deploy its resources to the build directory, and you cannot run Qt Creator without installing it.
<pre>
-WRONG-: srcdir/
        builddir/debug/
-RIGHT-: srcdir/
        builddir-debug/
</pre>
 
'''Note:''' If you built qt5 from the git repository and you get an error like
 
<code>Project ERROR: Unknown module(s) in QT: script</code>
 
..then In your qt5 build directory run:
 
<pre>make -j<number-of-cpu-cores+1> module-qtscript</pre>
 
Now back in your qt-creator build folder, you can configure and then compile qt creator:
 
On Linux, OS X:
<pre>
cd qt-creator-build
make qmake_all
make -j <number-of-cpu-cores+1>
</pre>
 
On Windows (MSVC):
<pre>
nmake
</pre>
 
Compilation takes a while (only a bit less than compilation of Qt libraries themselves)- so be patient. After it's finished, you can safely start using Qt Creator (binaries are located in qt-creator-build/bin directory).
 
For themes, and therefore colors, to work correctly, you may have to install QT Creator (see next step).
 
==Installing Qt Creator (optional)==
 
No further steps are required, but if you want to install it on your machine, type this:
Linux:
<pre>
make install INSTALL_ROOT=$INSTALL_DIRECTORY
</pre>
On Windows:
<pre>
nmake install INSTALL_ROOT=$INSTALL_DIRECTORY
</pre>


On OS X, just move the Qt Creator app bundle where you like.
Then proceed to read the [https://github.com/qt-creator/qt-creator/blob/master/README.md#compiling-qt-creator Compiling Qt Creator] section in [https://github.com/qt-creator/qt-creator/blob/master/README.md README.md]. You can find the file also in the local qt-creator directory.

Revision as of 12:56, 23 June 2021

En Ar Bg De El Es Fa Fi Fr Hi Hu It Ja Kn Ko Ms Nl Pl Pt Ru Sq Th Tr Uk Zh

Getting the source code

Qt Creator is open source. The arguably most convenient way to get the Qt Creator sources is with Git.

To get Qt Creator source code from git, you need first to install a git client.

If you have the git command client installed, you can then check out the sources from a terminal: 

git clone --recursive https://code.qt.io/qt-creator/qt-creator.git

This will check out the latest development version of Qt Creator in a qt-creator directory. If you are interested in using other branches of the Qt Creator repository, please see the Qt Creator section at Branch Guidelines.

Then proceed to read the Compiling Qt Creator section in README.md. You can find the file also in the local qt-creator directory.

Retrieved from "https://wiki.qt.io/index.php?title=Building_Qt_Creator_from_Git&oldid=38482"