summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qtee-building-running.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-06-30 11:37:43 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2014-08-29 10:52:44 +0300
commit5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b (patch)
tree8ae9a2bf9f20cd353245a40e37fe6801fe0cff14 /src/doc/src/qtee-building-running.qdoc
parent5a3e8d73b675a90cd6c48b94c0b226148857fa9f (diff)
Doc: split up the docs into multiple files
Split up the monolithic b2qt.qdoc into separate documentation files, making future edits and maintenance easier. Device-specific instructions are created in devices/ subdirectory, and shared documentation (referenced in multiple places) are moved to shared/. Change-Id: I9425297781a1dda9c08a149b0870a0389c575560 Reviewed-by: Samuli Piippo <samuli.piippo@digia.com> Reviewed-by: Kalle Viironen <kalle.viironen@digia.com>
Diffstat (limited to 'src/doc/src/qtee-building-running.qdoc')
-rw-r--r--src/doc/src/qtee-building-running.qdoc134
1 files changed, 134 insertions, 0 deletions
diff --git a/src/doc/src/qtee-building-running.qdoc b/src/doc/src/qtee-building-running.qdoc
new file mode 100644
index 0000000..7dbcb04
--- /dev/null
+++ b/src/doc/src/qtee-building-running.qdoc
@@ -0,0 +1,134 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use the contact form at
+** http://qt.digia.com/
+**
+** This file is part of Qt Enterprise Embedded.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** the contact form at http://qt.digia.com/
+**
+****************************************************************************/
+/*!
+ \page qtee-building-and-running.html
+ \title Building and Running Embedded Applications
+ \previouspage qtee-preparing-hardware.html
+ \nextpage qtee-custom-build-steps.html
+
+ \section1 Building and Running an Example
+
+ After you complete the installation and configuration steps for \SDK and the
+ target devices, you can test the setup by creating a simple \l{Qt Quick}
+ application and running it on the device:
+
+ \list 1
+ \li Make sure that your device is powered on and connected to the
+ development host.
+ \li In Qt Creator, select \b File > \b {New File or Project} >
+ \b Applications > \b{Qt Quick Application} > \b{Choose}.
+ \li Choose a location for your new project.
+ \li In the \b{Qt Quick Component Set} dialog, select \b{Qt Quick 2.2}
+ or \b{Qt Quick 2.2 Boot2Qt}.
+ \li In the \b{Kit Selection} dialog, select the kits for your
+ devices. You can also select the emulator kit to test running the
+ project in the emulator.
+ \li Click \b{Next} and finish the wizard.
+ \li In \b Projects > \b {Build & Run}, select the correct kit for your
+ connected device.
+ \li To build and run the project, click \inlineimage qtcreator-run.png
+ \endlist
+
+ \section1 Building and Running \B2Q Demos
+
+ You can find the \B2Q demo applications in Qt Creator.
+
+ \list 1
+ \li Go to \b Welcome > \b Examples.
+ \li Select a \e Boot2Qt Qt version from the drop-down list.
+ \li Select a demo you want to build.
+ \li In \b Projects > \b {Build & Run}, select the correct kit for your
+ connected device or emulator.
+ \li To build and run the project, click \inlineimage qtcreator-run.png
+ \endlist
+
+ \section1 Setting Up an Already Existing Project for Deployment
+
+ New Qt Quick application projects generated by Qt Creator always have the correct
+ settings for deployment on the device or emulator. However, other projects need
+ some changes. This includes projects created using the
+ \b File > \b {New File or Project} > \b Applications > \b{Qt Widget Application}
+ template.
+
+ As a general rule, application binaries and resources are deployed to the
+ \c {/data/user/qt/<APPLICATION_NAME>} directory. Therefore, the \c path variable for
+ the \c INSTALLS targets needs to be adjusted accordingly in .pro files.
+
+ Open the .pro file and define the \c target.path and \c INSTALLS variables as follows:
+
+ \badcode
+ target.path = /data/user/qt/$$TARGET
+ INSTALLS += target
+ \endcode
+
+ Above, \c {$$TARGET} expands to the application target (executable) name.
+
+ \section2 Deploying Application Resources
+
+ If the application depends on additional resources (such as QML files and
+ images), you need to deploy them as well. For example:
+
+ \badcode
+ appFiles.files = *.png qml
+ appFiles.path = /data/user/qt/$$TARGET
+ INSTALLS += appFiles
+ \endcode
+
+ Above, all PNG images from the application source directory, and the entire
+ \e qml subdirectory are included in the deployment.
+
+ Alternatively, the files used by the application can be stored into the application
+ executable using the \l{The Qt Resource System}{Qt resource system}. This way, simply
+ deploying the application binary is all that's required.
+*/
+
+/*!
+ \page qtee-custom-build-steps.html
+ \title Special Build & Run Options
+ \previouspage qtee-building-and-running.html
+ \nextpage qtee-customization.html
+
+ Qt Creator allows you to execute custom commands on the embedded device connected
+ to the development host, both during the build process and during deployment of your
+ application.
+
+ \section1 Custom Build Steps
+
+ To add a custom step to be executed during the build:
+
+ \list 1
+ \li In Qt Creator, go to \b Projects > \b {Build Settings}
+ \li Select \b Build configuration for the \e {\B2Q} version you want to customize.
+ \li Click \b {Add Build Step} and select \b {Custom Remote Command (via adb shell)}.
+ \li Enter the command to be executed.
+ \endlist
+
+ \section1 Custom Deployment Steps
+
+ To add a custom step to be executed during deployment:
+
+ \list 1
+ \li In Qt Creator, go to \b Projects > \b {Run Settings}
+ \li Select \b Run configuration for the \e {\B2Q} version you want to customize.
+ \li Click \b {Add Deploy Step} and select \b {Custom Remote Command (via adb shell)}.
+ \li Enter the command to be executed.
+ \endlist
+
+ \sa {Booting to a Custom Application}
+*/