diff options
author | Venu <venugopal.shivashankar@digia.com> | 2013-11-13 17:18:49 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-11-15 18:58:14 +0100 |
commit | ed1226d1120974d58666fd3f2ca080c660f34d9f (patch) | |
tree | 9ae3bbcdbde0804dbb319b112f96fc260bc5f62b | |
parent | 4d742e6271773489edcf5e2f421bc765d2c99e28 (diff) | |
download | qtdoc-ed1226d1120974d58666fd3f2ca080c660f34d9f.tar.gz |
Doc: Reorganized information in smaller topics
The getting started page had grown bigger so it was necessary
to break it up into smaller chunks for easier maintenance in
the future.
Besides reorganizing existing information, added a section about
publishing to Google Play, and fixed a few language and linking
issues.
Task-number: QTBUG-33580
Change-Id: Ic84dfb171b09c394e0bde977e7909b234e82775f
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
-rw-r--r-- | doc/src/external-resources.qdoc | 5 | ||||
-rw-r--r-- | doc/src/platforms/android.qdoc | 96 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-android.qdoc | 24 | ||||
-rw-r--r-- | doc/src/whatsnew/whatsnew52.qdoc | 4 |
4 files changed, 104 insertions, 25 deletions
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index b5b2ec0c..8c98411c 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -103,3 +103,8 @@ \externalpage http://qt-project.org/doc/qbs/index.html \title Qbs Manual */ + +/*! + \externalpage https://play.google.com/apps/publish + \title Google Play Developer Console +*/ diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc index f0bc7217..796b9b16 100644 --- a/doc/src/platforms/android.qdoc +++ b/doc/src/platforms/android.qdoc @@ -49,9 +49,22 @@ The following list summarizes what you can do with Qt for Android: \li Create and deploy Application Package (APK) using Qt Creator. \endlist -\section1 Getting Started +The following topics provide more details about how to use Qt for Android: +\list + \li \l{Getting Started with Qt for Android}{Getting Started} + \li \l{Porting to Android}{Porting a Qt Application} + \li \l{Adding OpenSSL Support} + \li \l{Qt Creator: Deploying Applications to Android Devices}{Deploying to the Device} + \li \l{Publishing to Google Play} + \li \l{Platform and Compiler Notes - Android}{Platform Notes} + \li \l{Android GNU C++ run-time licensing} +\endlist +*/ -\section2 Requirements +/*! +\page androidgs.html +\title Getting Started with Qt for Android +\brief Provides instructions to install and configure your development environment. In order to use Qt for Android, you need the following: @@ -90,7 +103,7 @@ to install: ./android update sdk \endcode -\section2 Installing Qt for Android +\section1 Installing Qt for Android You can install the binary package for Qt 5.1 or later to get Qt for Android. The \l{Qt Installation Program}{installer} containing the @@ -152,7 +165,7 @@ The binaries are installed to the \e{qtbase/bin} directory by default for the developer builds. You can check the install paths using the \c{qmake -query} command. -\section2 Configuring Qt Creator +\section1 Configuring Qt Creator After installing the Qt for Android binaries either using the installer or by cross-compiling, Qt Creator must be configured to start developing your first @@ -170,7 +183,11 @@ to test the setup. Use the \c{android} keyword in the search field under the \gui{Examples} tab in Qt Creator \gui{Welcome} mode to list all the examples tested for Android. -\section1 Porting a Qt Application +*/ +/*! +\page portingtoandroid.html +\title Porting to Android +\brief Provides instructions to port your existing Qt application to Android. In this section, we are going to port an existing Qt Application to Android and deploy it to the device. @@ -251,8 +268,12 @@ Qt Creator deploys your application on the Android device, if the device is detected by the PC. Otherwise, it tries to run the application on an AVD (Android Virtual Device). You will be prompted to create one if there are no AVDs found. +*/ -\section1 Adding OpenSSL Support +/*! +\page opensslsupport.html +\title Adding OpenSSL Support +\brief Provides instructions to bundle OpenSSL libraries with your Qt application for Android. The Qt installation package does not ship the OpenSSL libraries due to legal restrictions in some countries. If you want to use OpenSSL in your application, @@ -296,11 +317,62 @@ with the OpenSSL libraries bundled in it. Once the APK is ready, Qt Creator prompts you to choose the device to install the APK, and then you should see your application running on the device you selected. -\section1 Related Information -\list - \li \l{Platform and Compiler Notes - Android}{Platform Notes} - \li \l{Qt Creator: Deploying Applications to Android Devices} - \li \l{Android GNU C++ run-time licensing} - \li \l{Deploying an Application on Android} +*/ + +/*! +\page publishtogoogleplay.html +\title Publishing to Google Play +\brief Provides instructions to prepare your application for publishing. + +Qt for Android provides a complete solution to develop, build, and package your +applications for Android. Most of these tasks, especially packaging and +deployment are handled by Qt Creator providing rich developer experience. + +Every time you run the application using Qt Creator, an Android Application +Package (APK) is created and deployed onto the target (device or emulator) you +choose. With some minor changes to how the \e .apk is created, you can publish +your application on Google Play and monetize from it. The following +step-by-step instructions guide you to create an \e{.apk} that can go live +on Google Play: +\list 1 + \li Open your application project using Qt Creator v3.0 or later and change + its \uicontrol Build settings to build release version. + + \li Open \uicontrol Run settings of your project and select + \uicontrol {Create AndroidManifest.xml}. Qt Creator adds the manifest XML + based on the application's \e .pro file and opens it in \uicontrol General + mode. + + \note You can edit the \e AndroidManifest.xml in \uicontrol General or + \uicontrol {XML Source} mode. + + \li Check for the following in \e AndroidManifest.xml: + \list + \li \uicontrol{Minimum required SDK} is set to API 9 or above. + + \note Qt for Android is supported on devices with API 9 and above. + + \li Add \uicontrol{Application name} and \uicontrol{Application icon}. + + \li \uicontrol Permissions list has all the required permissions. + \endlist + + \li Set up a \uicontrol keystore to sign the \e .apk. You can create a new + keystore if you do not have one. + + \li Select \uicontrol{Open package location after build} and run your + application to build the \e .apk. Qt Creator builds the \e .apk and opens the + folder containing the \e .apk. + + \li Login into the \l{Google Play Developer Console} and upload the \e .apk + file, few screen captures of the application, and a description. \endlist + +Now your application is available to other Android device users via +Google Play. You can also choose to publish the application to a smaller +group, so that you can test and improve the application before publishing it to +a larger audience. + +See \l{Deploying an Application on Android} for more information about how the +packaging is done and how you can influence it. */ diff --git a/doc/src/platforms/platform-notes-android.qdoc b/doc/src/platforms/platform-notes-android.qdoc index 3cb5b0b3..011a1a2e 100644 --- a/doc/src/platforms/platform-notes-android.qdoc +++ b/doc/src/platforms/platform-notes-android.qdoc @@ -42,17 +42,18 @@ The easiest way to develop with Qt for Android is to use \l{http://qt-project.org/doc/qtcreator/creator-developing-android.html}{Qt Creator}. When you apply a \b{Qt for Android Kit} to a Qt Creator project, it will create and maintain a set of files which - are required to make your app run on Android. + are required to make your application run on Android. The files added to your project are: \list - \li Java files which serve as the entry point into your app and which will automatically load Qt - and execute the native code in your app - \li AndroidManifest.xml which provides meta-information about your app - \li Other XML files detailing the dependencies of your app + \li \e .java files will serve as the entry point into your application and + automatically load Qt to execute the native code in your application + \li \e AndroidManifest.xml which provides meta-information about your + application + \li Other XML files detailing the dependencies of your application \li Resource files - \li Depending on the deployment method selected in Qt Creator, additional files like libraries - and QML files can be included in the project. + \li Depending on the deployment method selected in Qt Creator, additional + files like libraries and QML files can be included in the project. \endlist Qt Creator adds these files in a subdirectory of your project called \b android. The contents of @@ -60,10 +61,11 @@ \section1 Application Package - On Android, apps are distributed in packages called APK. Qt Creator will manage building the - APK for you, but if you for some reason want to do this manually, you must first make sure - that the appropriate packaging and build files are in place. As mentioned, Qt Creator will - place these files in the \b android subfolder in your project. + On Android, apps are distributed in packages called \e APK. Qt Creator + builds the \e APK for you, but if you for some reason want to do this + manually, you must first make sure that the appropriate packaging and build + files are in place. For more detailed information about how the packaging + is done, see \l{Deploying an Application on Android}. \section1 Deployment diff --git a/doc/src/whatsnew/whatsnew52.qdoc b/doc/src/whatsnew/whatsnew52.qdoc index 6fb73641..1e97e70e 100644 --- a/doc/src/whatsnew/whatsnew52.qdoc +++ b/doc/src/whatsnew/whatsnew52.qdoc @@ -53,7 +53,7 @@ \section1 Support for New Platforms - \section2 Qt for Android + \section2 Android \list \li Full support for camera and recording @@ -65,7 +65,7 @@ For more information, visit the \l{Qt for Android} page. - \section2 Qt for iOS + \section2 iOS \list \li Media player support |