creator-projects-qbs.qdoc 2.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/****************************************************************************
**
** Copyright (c) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator
**
**
** 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.
**
**
****************************************************************************/

/*!
    \contentspage index.html
    \previouspage creator-project-cmake.html
    \page creator-project-qbs.html
    \nextpage creator-projects-autotools.html

    \title Setting Up a Qbs Project

    The Qt Build Suite (Qbs) and the Qbs plugin are still experimental, and
28
29
30
    therefore, you must first enable the plugin manually. If you build \QC
    yourself from our git repository, you also need to fetch the Qbs submodule to
    get Qbs support. See \l{Enabling the Qbs Plugin} below.
31
32
33
34
35

    To use Qbs to build a project, you must create a .qbs file for the project.
    For more information, see the
    \l{http://doc-snapshot.qt-project.org/qbs/index.html}{Qbs Manual}.

36
    \section1 Enabling the Qbs Plugin
37

38
39
40
    If you use a \QC binary release, you need to enable the plugin by
    selecting \gui Help > \gui {About Plugins} > \gui {Build Systems}
    > \gui {QbsProjectManager} and restarting \QC.
41

42
    To build the Qbs plugin yourself from the \QC git repository:
43

44
    \list 1
45

46
47
        \li Fetch the Qbs submodule in your \QC git checkout with
            \c {git submodule update --init}.
48

49
        \li Run qmake on \QC and build \QC again.
50

51
        \li Enable the Qbs plugin as described above.
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

    \endlist

    \section1 Building Applications with Qbs

    To build your application with Qbs:

    \list 1

        \li Create a .qbs file for your project. For examples, see the
            \c {tests\manual} directory in the qbs repository.

        \li In \QC, select \gui File > \gui {Open File or Project}.

        \li Select the .qbs file for your project.

            \image creator-qbs-project.png

        \li Select \gui Build > \gui {Build Project} to build the executable, so
            that you can specify it in the run settings of the project.

        \li Select \gui Projects > \gui {Run}, and specify the executable in the
            \gui Command field. This allows you to run it directly from \QC.
            This will happen automatically in a future release.

            \image creator-run-settings-qbs.png

        \li Click the
            \inlineimage qtcreator-run.png
            (\gui Run) button to run the application.

        \endlist

*/