Commit b32e5c4e authored by Leena Miettinen's avatar Leena Miettinen Committed by Nico Vertriest

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: default avatarMartin Smith <martin.smith@digia.com>
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
Reviewed-by: default avatarNico Vertriest <nico.vertriest@digia.com>
parent 70f22fa8
...@@ -92,93 +92,93 @@ ...@@ -92,93 +92,93 @@
./android update sdk ./android update sdk
\endcode \endcode
\section1 Developing with Qt 4 \section1 Developing with Qt 5
The Necessitas SDK automatically sets the paths to the required software You must download and install the latest Android NDK and SDK, and update the
in \QC, but you need to add the Qt version. \QC can then create the SDK to get the API and tools packages needed for development. In addition,
necessary kits for you. 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: To configure connections between \QC and Android devices:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \li Select \gui Tools > \gui Options > \gui Android to add paths to the
\gui {Qt Versions} > \gui Add to add the path to \c qmake path in Android NDK and SDK.
the Qt for Android SDK.
\li Select \gui Tools > \gui Options > \gui Android to check the paths
to the required software.
\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} \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 check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version. warning if it cannot find a suitable Qt version.
\li To create an application, select \gui File > \li Select \gui File > \gui {New File or Project} > \gui Applications >
\gui {New File or Project} > \gui Applications >
\gui {Qt Quick Application} > \gui Choose, and \gui {Qt Quick Application} > \gui Choose, and
follow the instructions of the wizard. For more information, see follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}. \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 \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 \gui Details to view the \gui {Deploy configurations}. For more
information about the options you have, see information about the options you have, see
\l{Deploying Applications to Android Devices}. \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 \li Connect the Android device to the development PC with a USB cable.
SDK to get the API and tools packages needed for development. In addition, You might be asked to select a device in the
you must install Qt for Android as part of Qt 5.2, or later. \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: To configure connections between \QC and Android devices:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Android to add paths to the \li Select \gui Tools > \gui Options > \gui {Build & Run} >
Android NDK and SDK. \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} \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 check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version. 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 \gui {Qt Quick Application} > \gui Choose, and
follow the instructions of the wizard. For more information, see follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}. \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 \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 \gui Details to view the \gui {Deploy configurations}. For more
information about the options you have, see information about the options you have, see
\l{Deploying Applications to Android Devices}. \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 \endlist
\section1 Selecting Android Devices \section1 Selecting Android Devices
......
...@@ -39,6 +39,17 @@ ...@@ -39,6 +39,17 @@
\image creator_android_tutorial_ex_app.png \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 \section1 Creating the Project
\list 1 \list 1
......
...@@ -57,7 +57,8 @@ ...@@ -57,7 +57,8 @@
\li \b {\l{Tutorials}} \li \b {\l{Tutorials}}
Now you are ready to start developing your own applications. 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 \endtable
*/ */
...@@ -33,14 +33,21 @@ ...@@ -33,14 +33,21 @@
You can test that your \QSDK installation is successful by opening an existing You can test that your \QSDK installation is successful by opening an existing
example application project. 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 \list 1
\li In the \gui Welcome mode, select \gui Examples (1). \li In the \gui Welcome mode, select \gui Examples (1).
\image qtcreator-gs-build-example-open.png "Selecting an example" \image qtcreator-gs-build-example-open.png "Selecting an example"
\li Select an example in the list of examples. You can also search for \li Select an example in the list of examples.
examples (2).
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 \note The project opens in the \gui Edit mode, and the documentation
for the example hides these instructions. To return to these for the example hides these instructions. To return to these
...@@ -67,7 +74,10 @@ ...@@ -67,7 +74,10 @@
If build errors occur, check that a \l{Adding Qt Versions} If build errors occur, check that a \l{Adding Qt Versions}
{Qt version} and \l{Adding Compilers}{compiler} are installed and {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 The \gui Build progress bar on the toolbar turns green when the
project is successfully built. The application opens on the device. project is successfully built. The application opens on the device.
......
...@@ -32,7 +32,9 @@ ...@@ -32,7 +32,9 @@
\QC provides a cross-platform, complete integrated development environment \QC provides a cross-platform, complete integrated development environment
(IDE) for application developers to create applications for multiple desktop (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}. operating systems. For more information, see \l{Supported Platforms}.
\table \table
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment