From 608822e7c8e986f033dd5f9bdcd3c5e78c0ee0f7 Mon Sep 17 00:00:00 2001
From: Jerome Pasion <jerome.pasion@digia.com>
Date: Fri, 12 Apr 2013 16:41:56 +0200
Subject: [PATCH] Doc: Revised the Getting Started page and installation info
-Added information about the Qt Installer
-Added content regarding the other parts of the documentation
Task-number: QTBUG-30647
Change-Id: I175658a17f4dbfd4f3bedfcec69748b9a8551147
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
---
doc/src/getting-started/gettingstarted.qdoc | 113 +++++++++++-------
.../getting-started/gettingstartedqml.qdoc | 1 -
doc/src/getting-started/gettingstartedqt.qdoc | 1 -
doc/src/getting-started/installer-README.qdoc | 99 +++++++++++++++
doc/src/index.qdoc | 2 +-
5 files changed, 169 insertions(+), 47 deletions(-)
create mode 100644 doc/src/getting-started/installer-README.qdoc
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index 066e8e8c..7e8e74c0 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -26,48 +26,73 @@
****************************************************************************/
/*!
- \title Getting Started Guides
-
- \group gettingStarted
-
- \section1 Creating Applications Using Qt Is Easy
- To help you on your way, we have created two tutorials creating two similar applications,
- but using different approaches.
-
- Before starting, make sure to download either the commercial evaluation or the open source
- version of the Qt SDK and familiarize yourself with the \l{development tools}. The Qt SDK
- provides the \l{Qt Creator} IDE to make the development of Qt applications easy and efficient.
-
- \section1 User Interface Options
- In addition to intuitive, cross-platform abstractions for anything from
- \l{Core Internals#Threading}{threading}
- and \l{Networking and Connectivity}{network communication} to
- \l{Qt Multimedia Overview}{video playback and web camera access}, Qt provides two separate ways
- of creating graphical user interfaces which favor somewhat different use cases.
-
- The \l{Qt Quick} Module provides a declarative language for creating fluid and animated
- user interfaces, suited e.g. for applications which require a very distinctive look and feel and
- animated user interface elements, applications intended to run on small screens and applications
- targeted for touch input devices.
-
- The \l {Qt Widgets} Module provides support for the more traditional desktop applications,
- integrating seamlessly with the target platform, whether it's Mac OS X, Windows, KDE or Gnome.
- It is both a robust and flexible C++-based class library with existing components for many
- typical user interface widgets, and which is convenient to extend with new functionality
- when the need arises.
-
- Which module you choose to base your application on depends on the type of application
- you want to create. Since both approaches integrate with the rest of the Qt libraries, it
- is also possible to write much of the application logic independently. Familiarize yourself
- with the two options in the following tutorials before making your decision.
-
- For more detailed information, see the \l {User Interfaces} overview.
-
- \section1 The Tutorials
- There are two separate tutorials for creating two similar applications. One implements the
- user interface using Qt Quick, while the other uses Qt Widgets.
-
- Please click on one of the links below to start the ride.
-
-*/
+ \page gettingstarted.html
+ \title Getting Started with Qt
+ \brief A quick guide for developers
+
+ \section1 Downloading and Installing Qt
+
+ The \l{Opensource Downloads}{Downloads} page contains Qt download links,
+ where Qt and Qt Creator can be downloaded for different development
+ platforms.
+
+ \section2 Installing with the Installation Program
+
+ The Qt Installation Program can download the Qt libraries and tools as well
+ as the reference documentation and code samples. The \l{Qt Installation
+ Program} page contains information about installation process.
+
+ \section2 Installing from the Qt Sources
+
+ Qt may also be installed from the sources. Simply download the sources
+ (available from the \l{Opensource Downloads}{Downloads} page) and follow the
+ instructions according to the development platform page here:
+ \l Installation.
+
+ \section1 Exploring the Tools
+
+ \l{Qt Creator}, the Qt IDE, allows quick development time by integrating
+ tools such as a code editor, a UI designer, a debugger, and other project
+ management tools such as version control.
+
+ For more information, these pages describe the tools and processes involved:
+ \list
+ \li \l{Development Tools}
+ \li \l{external: Qt Creator Manual}{Qt Creator Manual}
+ \endlist
+ \section1 Creating Applications Using Qt
+
+ Qt 5's modularized nature means that modules may be omitted during the
+ build process, producing libraries that are smaller in size and with
+ less complexities. Depending on their support and target platforms,
+ modules are either an \e essential or an \e add-on.
+
+ These pages explain the modules and the support level for different
+ platforms: \list \li \l{All Modules}{Qt Modules} \li \l{Supported Platforms}
+ \endlist
+
+ To help you on your way, we created two tutorials creating two similar
+ applications, but using different approaches. One implements the user
+ interface using Qt Quick, while the other uses Qt Widgets.
+
+ \list
+ \li \l{Getting Started Programming with Qt Widgets}
+ \li \l{Getting Started Programming with Qt Quick}
+ \endlist
+
+ \section1 Where to Go from Here
+
+ 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 our
+ API.
+
+ \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
+
+ Qt's vibrant and active community site, \l{http://qt-project.org} houses
+ a wiki, a forum, and additional learning guides and presentations.
+*/
diff --git a/doc/src/getting-started/gettingstartedqml.qdoc b/doc/src/getting-started/gettingstartedqml.qdoc
index 7d298953..2a0aa858 100644
--- a/doc/src/getting-started/gettingstartedqml.qdoc
+++ b/doc/src/getting-started/gettingstartedqml.qdoc
@@ -28,7 +28,6 @@
/*!
\page gettingstartedqml.html
\title Getting Started Programming with Qt Quick
- \ingroup gettingStarted
Welcome to the world of QML, the declarative UI language. In this Getting
Started guide, we will create a simple text editor application using QML.
diff --git a/doc/src/getting-started/gettingstartedqt.qdoc b/doc/src/getting-started/gettingstartedqt.qdoc
index 8f07b88a..e5ccd7c7 100644
--- a/doc/src/getting-started/gettingstartedqt.qdoc
+++ b/doc/src/getting-started/gettingstartedqt.qdoc
@@ -29,7 +29,6 @@
\page gettingstartedqt.html
\title Getting Started Programming with Qt Widgets
- \ingroup gettingStarted
In this topic, we teach basic Qt knowledge by implementing a simple Notepad
application using C++ and the \l{QtWidgets Module}{Qt Widgets module}. We use the
diff --git a/doc/src/getting-started/installer-README.qdoc b/doc/src/getting-started/installer-README.qdoc
new file mode 100644
index 00000000..b9636c39
--- /dev/null
+++ b/doc/src/getting-started/installer-README.qdoc
@@ -0,0 +1,99 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qtinstaller.html
+\title Qt Installation Program
+\brief An installer for Qt libraries and tools
+
+You can use the Qt 5 installation program to 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 Basic development tools, prebuilt for a particular development platform
+\li Documentation
+\li Qt in source code form (needed only if you want to build the framework and
+ tools yourself)
+\endlist
+
+Install Qt libraries to develop or run applications that need the Qt runtimes or
+to try out example applications built with Qt.
+
+Qt Creator is designed to make Qt development easier, but you can also use a 3rd
+party IDE (such as MS Visual Studio), or just an editor and command line, in
+addition to basic Qt development tools (Qt Designer, Qt Assistant, qmlscene, and
+so on).
+
+
+\section1 Installing Qt 5
+
+You can download Qt 5 from \l{http://qt-project.org/downloads}. The site
+provides download links for all supported development platforms.
+
+Start the installation program like any executable on the development platform.
+On Linux, you might first have to make the installation program executable.
+
+Select the components that you want to install and follow the instructions of
+the installation program to complete the installation.
+
+Use the Maintenance Tool under \e{<install_dir>} to remove all installed
+components.
+
+\section1 Starting Development Tools
+
+You can start Qt Creator directly after the installation by selecting the option
+on the last page of the installation program. You can start most of
+the development tools, such as GUI designers, compilers, and debuggers
+directly from Qt Creator. You can also access the installed documentation and
+example applications from Qt Creator.
+
+In addition to Qt Creator, the installer is able to install the full set of Qt
+tools, for example:
+
+\list
+\li \l{Qt Assistant}, the Qt documentation reader
+\li \l{Prototyping with qmlscene}{Qt QML Scene}, the viewer for Qt Quick 2 files
+\li Qt QML Viewer, the viewer for Qt Quick 1 files
+\li \l{Qt Designer}, the GUI designer for Qt widgets-based applications
+\li \l{Qt Linguist}, the language translation manager tool
+\endlist
+
+The development tools are located in the directory
+\e{<install_dir>}/\e{<version>}/\e{<compiler>}/bin. For Windows, the MinGW
+toolchain is placed in \e{<install_dir>}\Tools. You can run them from Qt Creator
+or from the command line. You can also launch some of them as standalone
+applications.
+
+\section1 Running Example Applications
+
+You can open most example applications in the Qt Creator Welcome mode to build
+and run them. Additional examples can be opened by browsing
+\e{<install_dir>}/\e{<version>}/\e{<compiler>}/examples.
+
+*/
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index eae484a2..ba3e3433 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -62,7 +62,7 @@
\section1 Getting Started
\list
- \li \l{Getting started Guides}{Getting Started with Qt}
+ \li \l{Getting Started with Qt}
\li \l{What's New in Qt 5}
\li \l{Qt Examples and Tutorials}{Examples and Tutorials}
\li \l{Supported Platforms}
--
GitLab