summaryrefslogtreecommitdiff
path: root/doc/src/getting-started/gettingstarted.qdoc
blob: 6d1226d99a3d495e800b43a69fb90271d4d9bb04 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** 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. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page gettingstarted.html
    \title Getting Started with Qt
    \brief A quick guide for developers

    You can install the Qt Framework and tools by using an online or offline
    installer or by building the source packages yourself. In the
    \e{online installer}, you can select the Qt versions, tools, and Add-On
    components to download and install depending on the license attached to your
    \l{Qt Account}.

    An \e{offline installer} is a single package that contains all of Qt and
    Add-Ons relevant for a target platform.

    You can download Qt 5 installers from the \l Downloads page.

    You can use the Qt installers to download and install the following
    components:

    \list
    \li Qt libraries, prebuilt for a particular development platform (operating
     system and compiler)
    \li Qt Creator integrated development environment (IDE)
    \li Reference Documentation and examples
    \li Qt in source code form (needed only if you want to build the framework and
      tools yourself)
    \li Add-On components that are relevant for different platforms
    \endlist

    After downloading, start the installer like any executable on the
    development platform.

    To run the installer, you need a Qt Account. You can use your Qt Account
    credentials to sign-in to all Qt services, including the forums and wiki.
    If you do not already have a Qt Account, you can create one during the
    installation process.

    To complete the installation, select the components that you want to install
    and follow the instructions of the installation program.

    Use the Maintenance Tool under \e{<install_dir>} to add components and to
    update or remove installed components.

    \section2 Platform Requirements

    Developing applications on different platforms are covered in the platform
    pages.
    \list
    \li \l{Getting Started with Qt for Android}{Android}
    \li \l{Qt for iOS}{iOS}
    \li \l{Qt for Windows}{Windows}
    \li \l{Qt for Linux/X11}{Linux/X11}
    \li \l{Qt for macOS}{\macos}
    \li \l{Qt for WinRT}{Windows Runtime}
    \endlist

    For more information, visit the \l{Community Supported Platforms}
    {supported platforms} page.

    \section1 Explore Qt

    We invite you to explore the rest of Qt. We prepared overviews which help
    you decide which APIs to use and our examples demonstrate how to use them.

    To view a list of all Qt examples, visit the \l{List of Qt Examples} page.

    \section2 Setting Up Projects
        \list
        \li \l{Qt Creator: Creating Qt Quick Projects}{Qt Quick Projects}
        \li \l{Qt Creator: Creating a Qt Widget Based Application}{Qt Widget Projects}
        \li \l{Qt Creator: Configuring Projects}{Configuring Projects}
        \endlist

    \section2 Developing with Qt Creator
        \list
        \li \l{Qt Creator: Building for Multiple Platforms}{Building for Multiple Platforms}
        \li \l{Qt Creator: Running on Multiple Platforms}{Running on Multiple Platforms}
        \li \l{Qt Creator: Deploying to Mobile Devices}{Deploying to Mobile Devices}
        \li \l{Qt Creator: Connecting Mobile Devices}{Connecting Mobile Devices}
        \endlist
        \list
        \li \l{Qt Creator: Building and Running}{See more}
        \endlist

    \section2 Reference Documentation
        \list
        \li \l{Qt Overviews} - list of topics about application development
        \li \l{Qt Examples and Tutorials}{Examples and Tutorials} - code samples and tutorials
        \li \l{Qt Reference Pages} - a listing of C++ and QML APIs
        \endlist

    \section1 Qt Project Community

    Qt's vibrant and active community site, \l{http://qt.io} houses
    a wiki, a forum, and additional learning guides and presentations.
*/