summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2020-10-08 17:52:05 +0200
committerJerome Pasion <jerome.pasion@qt.io>2020-10-22 18:26:40 +0200
commit8427a2dbd989daf5f5d6c314f3702c340f784fac (patch)
treea8869d1423df9ecf194a78101b4f3d4af93fea95
parenta29745191d9842d47971655d4b49316b5091c49f (diff)
downloadqtdoc-8427a2dbd989daf5f5d6c314f3702c340f784fac.tar.gz
Update "Getting Started with Qt" page
Installation process is streamlined in Qt 6. Task-number: QTBUG-87293 Change-Id: I82cfc8a4636efe9710e2ec2c9a3ccf1f1ef45036 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--doc/src/getting-started/gettingstarted.qdoc121
1 files changed, 51 insertions, 70 deletions
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index c7d67948..34bf6117 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -30,51 +30,31 @@
\title Getting Started with Qt
\brief A quick guide for developers
- \section1 Installing Qt
- You can install the Qt Framework and tools by using an \l{Online Installation}{online}
- or \l{Offline Installation}{offline} installer, or by
- \l{Building Qt Sources}{building the source packages yourself}.
+ This guide shows how to get started developing with Qt.
- The installers allow you to download and install the following
- components:
+ \section1 Get and install Qt
- \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
-
- \section2 Online Installation
-
- In the \e{online installer}, you can select commercial or open source
- versions of Qt, tools, and Add-On components to install. Using the online
- installer requires signing in to your \l{Qt Account}. The installer
- retrieves the license attached to the account from a server and provides a
- list of available components corresponding to the license.
+ The installation process is straightforward. The Qt Online Installer
+ gives you the choice of installing only the modules and tools you need.
- The online installer is available from the Qt \l Downloads page.
+ \section2 1. Create a Qt Account
- \section2 Offline Installation
+ To begin, create a \l{Qt Account}. This account gives
+ you access to a web portal to manage your licenses and access to the forums
+ and wikis. Also, make sure you read the \l{Qt Licensing} page regarding your
+ chosen license.
- An \e{offline installer} is a single package that contains all of Qt and
- Add-Ons relevant for a target platform. Users with a commercial license
- can either sign in with their Qt account or with their Qt license key
- during the installation process. The license key is available in the
- \l {Qt Account} Web portal.
+ \section2 2. Download the Installer
- The offline installer is available \l{https://www.qt.io/offline-installer}{here}.
+ \li Download the installer from the \l {Qt Downloads}{Downloads} page. With
+ the \e{Qt Online Installer}, you can install both commercial or open
+ source versions of Qt, development tools, and other components. The online
+ installer requires your \l{Qt Account}. The installer retrieves the license
+ attached to the account from a server and provides a list of available
+ components corresponding to the license.
- \section2 Installation Process
-
- 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.
+ \section2 3. Install Qt
To complete the installation, select the components that you want to install
and follow the instructions of the installation program.
@@ -84,37 +64,11 @@
\youtube I5jasWrsxT0
- \section2 Updating or Removing Qt
-
- Once Qt is installed, you can use the Maintenance Tool under \e{<install_dir>}
- to add components and to update or remove installed components.
-
- \section2 Platform Requirements
+ \section3 Updating or Removing Components
- Specific requirements and instructions for developing applications on different
- platforms are covered in the platform pages.
-
- \list
- \li Desktop Platforms
- \list
- \li \l{Qt for Linux/X11}{Linux/X11}
- \li \l{Qt for macOS}{\macos}
- \li \l{Qt for Windows}{Windows}
- \endlist
- \li Embedded Platforms
- \list
- \li \l{Qt for Embedded Linux}{Embedded Linux}
- \li \l{Qt for Device Creation}
- \endlist
- \li Mobile Platforms
- \list
- \li \l{Qt for Android}{Android}
- \li \l{Qt for iOS}{iOS}
- \endlist
- \endlist
-
- For more information, visit the \l{Supported Platforms}
- {supported platforms} page.
+ Once Qt is installed, you can use the \e{Maintenance Tool} under
+ \e{<install_dir>} to add components, update, or remove installed
+ components.
\section1 Create Your First Applications
@@ -160,6 +114,33 @@
\li \l{Qt Creator: Building and Running}{See more}
\endlist
+ \section2 Platform Requirements
+
+ There are pecific requirements and instructions for developing
+ applications on different platforms are covered in the platform pages.
+
+ \list
+ \li Desktop Platforms
+ \list
+ \li \l{Qt for Linux/X11}{Linux/X11}
+ \li \l{Qt for macOS}{\macos}
+ \li \l{Qt for Windows}{Windows}
+ \endlist
+ \li Embedded Platforms
+ \list
+ \li \l{Qt for Embedded Linux}{Embedded Linux}
+ \li \l{Qt for Device Creation}
+ \endlist
+ \li Mobile Platforms
+ \list
+ \li \l{Qt for Android}{Android}
+ \li \l{Qt for iOS}{iOS}
+ \endlist
+ \endlist
+
+ For more information, visit the \l{Supported Platforms}
+ {supported platforms} page.
+
\section2 Reference Documentation
\list
\li \l{Qt Overviews} - list of topics about application development
@@ -167,8 +148,8 @@
\li \l{Qt Reference Pages} - a listing of C++ and QML APIs
\endlist
- \section1 Qt Project Community
+ \section1 Participate in the Qt Community
- Qt's vibrant and active community site, \l{http://qt.io} houses
+ Qt's vibrant and active community site \l{http://qt.io}, houses
a wiki, a forum, and additional learning guides and presentations.
*/