creator-projects-build-run-tutorial.qdoc 3.76 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
26
    \contentspage {Qt Creator Manual}
27
    \previouspage creator-configuring.html
28
    \page creator-build-example-application.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
29
    \nextpage creator-tutorials.html
30

Leena Miettinen's avatar
Leena Miettinen committed
31
    \title Building and Running an Example
32

33
    You can test that your \QSDK installation is successful by opening an existing
34 35
    example application project.

36 37 38 39
    To run an example application on an Android or iOS device, you must set up
    the development environment for Android or iOS. For more information, see
    \l{Connecting Android Devices} and \l{Connecting iOS Devices}.

40 41 42 43 44 45 46 47
    To run an example application on an embedded device, you must set up
    Qt for Device Creation on the development host and create connections
    between the host and devices. For more information, see the
    \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html}
    {Installation Guide} in the
    \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
    documentation.

48 49
    \list 1

50
        \li In the \uicontrol Welcome mode, select \uicontrol Examples (1).
51 52 53

            \image qtcreator-gs-build-example-open.png "Selecting an example"

54 55
        \li Select an example in the list of examples.

56 57
            You can also search for examples. Enter the \uicontrol android or
            \uicontrol iOS keyword in the search field (2) to list all the
58 59 60
            examples tested for Android or iOS. To list examples that you can
            run on embedded devices, enter the \uicontrol Boot2Qt keyword in the
            search field (commercial only).
61

62
        \li To check that the application code can be compiled and linked for a
63
            device, click the \uicontrol {Kit Selector} and select a
64
            \l{glossary-buildandrun-kit}{kit} for the
65
            device.
66

67
            \image qtcreator-gs-build-example-kit-selector.png "Selecting a kit to build with"
68

69 70 71 72
            If you installed \QC as part of a Qt installation, it should have
            automatically detected the installed kit. If no kits are available,
            see \l{Adding Kits}.

73
        \li Click
Leena Miettinen's avatar
Leena Miettinen committed
74
            \inlineimage qtcreator-run.png
75
            (\uicontrol Run) to build and run the application.
76

77
        \li To see the compilation progress, press \key{Alt+4} to open the
78
            \uicontrol {Compile Output} pane.
79

80 81
            If build errors occur, check that a \l{Adding Qt Versions}
            {Qt version} and \l{Adding Compilers}{compiler} are installed and
82 83 84 85
            configured and that the necessary kits are configured. If you are
            building for an \l{Connecting Android Devices}{Android device} or
            \l{Connecting iOS Devices}{iOS device}, check that the development
            environment has been set up correctly.
86

87
            The \uicontrol Build progress bar on the toolbar turns green when the
88
            project is successfully built. The application opens on the device.
89 90 91 92

    \endlist

*/