aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2014-01-17 10:19:58 +0100
committerNico Vertriest <nico.vertriest@digia.com>2014-01-20 12:12:16 +0100
commitb32e5c4ed0a43c2457c06fdf68953952e10c02c6 (patch)
tree65ece818e895faa493b45ee40e65a0b7b61df33d
parent70f22fa823e56bd8385c26c8240fba9c7d664db4 (diff)
Doc: make the Android setup instructions more prominent
Feedback from users indicates that they cannot find the instructions for setting up the Android development environment. Added links to the instructions in several high level topics. Also, moved the Qt 5 instructions above the Qt 4 instructions in "Connecting Android Devices". Change-Id: Ie31bc27b959ac5a7146f00a576a900b932c07a98 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
-rw-r--r--doc/src/android/androiddev.qdoc86
-rw-r--r--doc/src/android/creator-android-app-tutorial.qdoc11
-rw-r--r--doc/src/overview/creator-getting-started.qdoc3
-rw-r--r--doc/src/projects/creator-projects-build-run-tutorial.qdoc16
-rw-r--r--doc/src/qtcreator.qdoc4
5 files changed, 72 insertions, 48 deletions
diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc
index 884599a859f..cc816822817 100644
--- a/doc/src/android/androiddev.qdoc
+++ b/doc/src/android/androiddev.qdoc
@@ -92,93 +92,93 @@
./android update sdk
\endcode
- \section1 Developing with Qt 4
+ \section1 Developing with Qt 5
- The Necessitas SDK automatically sets the paths to the required software
- in \QC, but you need to add the Qt version. \QC can then create the
- necessary kits for you.
+ You must download and install the latest Android NDK and SDK, and update the
+ SDK to get the API and tools packages needed for development. In addition,
+ you must install Qt for Android as part of Qt 5.2, or later.
+
+ For more information, see \l{Qt for Android}.
To configure connections between \QC and Android devices:
\list 1
- \li Select \gui Tools > \gui Options > \gui {Build & Run} >
- \gui {Qt Versions} > \gui Add to add the path to \c qmake path in
- the Qt for Android SDK.
-
- \li Select \gui Tools > \gui Options > \gui Android to check the paths
- to the required software.
+ \li Select \gui Tools > \gui Options > \gui Android to add paths to the
+ Android NDK and SDK.
- \image qtcreator-options-android.png "Android options"
+ \image qtcreator-options-android1.png "Android options"
\li Select the \gui {Automatically create kits for Android tool chains}
check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version.
- \li To create an application, select \gui File >
- \gui {New File or Project} > \gui Applications >
+ \li Select \gui File > \gui {New File or Project} > \gui Applications >
\gui {Qt Quick Application} > \gui Choose, and
follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}.
- \li To specify information for the Android manifest file, select
- \gui Projects > \gui Run for the \gui Android kit.
-
- \li Select \gui Details to view the
- \gui {Package configurations}. For more information about the
- options you have, see
- \l{Specifying Settings for Qt 4 Packages}.
-
\li To specify settings for deploying applications to Android, select
+ \gui Projects > \gui Run for the \gui Android kit, and then select
\gui Details to view the \gui {Deploy configurations}. For more
information about the options you have, see
\l{Deploying Applications to Android Devices}.
- \endlist
+ \li Enable debugging on your Android device.
- \section1 Developing with Qt 5
+ Debugging is enabled in different ways on different Android devices.
+ Look for \gui {USB Debugging} under \gui {Developer Options}. On
+ some devices \gui {Developer Options} is hidden and becomes visible
+ when you tap the \gui {Build number} field in \gui Settings >
+ \gui About several times.
- You must download and install the latest Android NDK and SDK, and update the
- SDK to get the API and tools packages needed for development. In addition,
- you must install Qt for Android as part of Qt 5.2, or later.
+ \li Connect the Android device to the development PC with a USB cable.
+ You might be asked to select a device in the
+ \gui {Select Android Devices} dialog.
+ \endlist
- For more information, see \l{Qt for Android}.
+ \section1 Developing with Qt 4
+
+ The Necessitas SDK automatically sets the paths to the required software
+ in \QC, but you need to add the Qt version. \QC can then create the
+ necessary kits for you.
To configure connections between \QC and Android devices:
\list 1
- \li Select \gui Tools > \gui Options > \gui Android to add paths to the
- Android NDK and SDK.
+ \li Select \gui Tools > \gui Options > \gui {Build & Run} >
+ \gui {Qt Versions} > \gui Add to add the path to \c qmake path in
+ the Qt for Android SDK.
- \image qtcreator-options-android1.png "Android options"
+ \li Select \gui Tools > \gui Options > \gui Android to check the paths
+ to the required software.
+
+ \image qtcreator-options-android.png "Android options"
\li Select the \gui {Automatically create kits for Android tool chains}
check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version.
- \li Select \gui File > \gui {New File or Project} > \gui Applications >
+ \li To create an application, select \gui File >
+ \gui {New File or Project} > \gui Applications >
\gui {Qt Quick Application} > \gui Choose, and
follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}.
+ \li To specify information for the Android manifest file, select
+ \gui Projects > \gui Run for the \gui Android kit.
+
+ \li Select \gui Details to view the
+ \gui {Package configurations}. For more information about the
+ options you have, see
+ \l{Specifying Settings for Qt 4 Packages}.
+
\li To specify settings for deploying applications to Android, select
- \gui Projects > \gui Run for the \gui Android kit, and then select
\gui Details to view the \gui {Deploy configurations}. For more
information about the options you have, see
\l{Deploying Applications to Android Devices}.
- \li Enable debugging on your Android device.
-
- Debugging is enabled in different ways on different Android devices.
- Look for \gui {USB Debugging} under \gui {Developer Options}. On
- some devices \gui {Developer Options} is hidden and becomes visible
- when you tap the \gui {Build number} field in \gui Settings >
- \gui About several times.
-
- \li Connect the Android device to the development PC with a USB cable.
- You might be asked to select a device in the
- \gui {Select Android Devices} dialog.
\endlist
\section1 Selecting Android Devices
diff --git a/doc/src/android/creator-android-app-tutorial.qdoc b/doc/src/android/creator-android-app-tutorial.qdoc
index 70ee24416e1..03b2a0cee06 100644
--- a/doc/src/android/creator-android-app-tutorial.qdoc
+++ b/doc/src/android/creator-android-app-tutorial.qdoc
@@ -39,6 +39,17 @@
\image creator_android_tutorial_ex_app.png
+ \section1 Setting up the Development Environment
+
+ To be able to build and run the application, you must download and install
+ the latest Android NDK and SDK, and update the SDK to get the API and tools
+ packages needed for development. In addition, you must install the
+ Java SE Development Kit (JDK) and Apache Ant. After you have installed all
+ these tools, you must specify the paths to them in \QC.
+
+ For detailed instructions, see \l{Qt for Android} and
+ \l{Connecting Android Devices}.
+
\section1 Creating the Project
\list 1
diff --git a/doc/src/overview/creator-getting-started.qdoc b/doc/src/overview/creator-getting-started.qdoc
index 9a01ca60470..80078661999 100644
--- a/doc/src/overview/creator-getting-started.qdoc
+++ b/doc/src/overview/creator-getting-started.qdoc
@@ -57,7 +57,8 @@
\li \b {\l{Tutorials}}
Now you are ready to start developing your own applications.
- Pick a tutorial to follow in \l{Tutorials}
+ Pick a tutorial to follow in \l{Tutorials}. To start developing
+ for Android devices, select \l{Creating an Android Application}.
\endtable
*/
diff --git a/doc/src/projects/creator-projects-build-run-tutorial.qdoc b/doc/src/projects/creator-projects-build-run-tutorial.qdoc
index 361fcbcfa45..451dd48190b 100644
--- a/doc/src/projects/creator-projects-build-run-tutorial.qdoc
+++ b/doc/src/projects/creator-projects-build-run-tutorial.qdoc
@@ -33,14 +33,21 @@
You can test that your \QSDK installation is successful by opening an existing
example application project.
+ 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}.
+
\list 1
\li In the \gui Welcome mode, select \gui Examples (1).
\image qtcreator-gs-build-example-open.png "Selecting an example"
- \li Select an example in the list of examples. You can also search for
- examples (2).
+ \li Select an example in the list of examples.
+
+ You can also search for examples (2). Enter the \gui android or
+ \gui iOS keyword in the search field to list all the examples tested
+ for Android or iOS.
\note The project opens in the \gui Edit mode, and the documentation
for the example hides these instructions. To return to these
@@ -67,7 +74,10 @@
If build errors occur, check that a \l{Adding Qt Versions}
{Qt version} and \l{Adding Compilers}{compiler} are installed and
- configured and that the necessary kits are configured.
+ 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.
The \gui Build progress bar on the toolbar turns green when the
project is successfully built. The application opens on the device.
diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc
index e5a01f13079..685345a99a4 100644
--- a/doc/src/qtcreator.qdoc
+++ b/doc/src/qtcreator.qdoc
@@ -32,7 +32,9 @@
\QC provides a cross-platform, complete integrated development environment
(IDE) for application developers to create applications for multiple desktop
- and mobile device platforms. It is available for Linux, Mac OS X and Windows
+ and mobile device platforms, such as \l{Connecting Android Devices}{Android}
+ and \l{Connecting iOS Devices}{iOS}. It is available for Linux, Mac OS X and
+ Windows
operating systems. For more information, see \l{Supported Platforms}.
\table