diff options
| author | Mikko Gronoff <mikko.gronoff@qt.io> | 2025-03-12 15:05:09 +0200 |
|---|---|---|
| committer | Mikko Gronoff <mikko.gronoff@qt.io> | 2025-03-13 12:40:16 +0000 |
| commit | 5e1be2926bf6eeec81e82165809212c5599ed3b5 (patch) | |
| tree | f4aad231278e9b3d55e40a0c89173ace51b417f1 | |
| parent | 7db9a1314622ad11e12c64cb44e70fea134d29b1 (diff) | |
Update Getting Started demo tutorial texts & images
to match latest boot2qt documentation.
Change-Id: Icca7f4a8d8a71ebb37665248a63dcdc7d58b9610
Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
| -rw-r--r-- | startupscreen/assets/b2qt-device-in-kit.png | bin | 25518 -> 19210 bytes | |||
| -rw-r--r-- | startupscreen/assets/b2qt-edit-mode-pro-file.png | bin | 12752 -> 62557 bytes | |||
| -rw-r--r-- | startupscreen/assets/b2qt-run-button.png | bin | 6031 -> 9304 bytes | |||
| -rw-r--r-- | startupscreen/assets/b2qt-select-kit.png | bin | 16053 -> 14113 bytes | |||
| -rw-r--r-- | startupscreen/assets/b2qt-tutorial-deploying.html | 41 |
5 files changed, 27 insertions, 14 deletions
diff --git a/startupscreen/assets/b2qt-device-in-kit.png b/startupscreen/assets/b2qt-device-in-kit.png Binary files differindex 9462a3a..933c771 100644 --- a/startupscreen/assets/b2qt-device-in-kit.png +++ b/startupscreen/assets/b2qt-device-in-kit.png diff --git a/startupscreen/assets/b2qt-edit-mode-pro-file.png b/startupscreen/assets/b2qt-edit-mode-pro-file.png Binary files differindex 79dc4e5..42bf9dc 100644 --- a/startupscreen/assets/b2qt-edit-mode-pro-file.png +++ b/startupscreen/assets/b2qt-edit-mode-pro-file.png diff --git a/startupscreen/assets/b2qt-run-button.png b/startupscreen/assets/b2qt-run-button.png Binary files differindex f0c1a8e..65318d6 100644 --- a/startupscreen/assets/b2qt-run-button.png +++ b/startupscreen/assets/b2qt-run-button.png diff --git a/startupscreen/assets/b2qt-select-kit.png b/startupscreen/assets/b2qt-select-kit.png Binary files differindex b5b900f..c8059b9 100644 --- a/startupscreen/assets/b2qt-select-kit.png +++ b/startupscreen/assets/b2qt-select-kit.png diff --git a/startupscreen/assets/b2qt-tutorial-deploying.html b/startupscreen/assets/b2qt-tutorial-deploying.html index be626b8..9039bab 100644 --- a/startupscreen/assets/b2qt-tutorial-deploying.html +++ b/startupscreen/assets/b2qt-tutorial-deploying.html @@ -1,27 +1,40 @@ <div class="descr"> <p>You can deploy all kinds of Qt projects to your target device: Qt Examples and projects that you have created yourself. In this tutorial, we use Qt Creator's project wizard and create a new Qt Quick project. We build and run the project, and deploy it to a target device.</p> -<p>This tutorial guides how you deploy a project to one of the reference target devices with pre-built images (see Reference Target Devices and Development Hosts). However, you should follow similar steps when you deploy to a target device where you have built an image yourself.</p> -<p>The tutorial assumes that you have installed the Boot to Qt software stack to your host platform and flashed it to your target device. That is, the <i>Boot to Qt Startup Screen</i> appears on the device screen when you power on the device.</p> -<p><b>Note: </b>In Linux, ensure that you have access to plugged in devices. For more information, see Setting Up USB Access to Embedded Devices.</p> +<p>This tutorial guides how you deploy a project to one of the target devices with pre-built images (see Supported Target Devices and Development Hosts). However, you should follow similar steps when you deploy to a target device where you have built an image yourself.</p> +<p>The tutorial assumes that you have installed the Boot to Qt software stack to your development host and flashed it to your target device. That is, <b>Get Started with Boot to Qt</b> appears on the device screen when you power on the device.</p> -<h2 id="preparation-of-qt-kit">Preparation of Qt Kit</h2> +<h2 id="preparation-of-qt-kit">Preparation of Boot to Qt Kit</h2> <p>Qt Creator groups build and run specific settings as kits. Each kit consists of a set of values that define one environment, such as a target device, tool chain, Qt version, and debugger command to use.</p> <p>Before deploying, make sure that your kit contains the target device. Connect your target device to the host platform, open Qt Creator, and execute the following steps:</p> -<ol class="1" type="1"><li>Select <b>Tools > Options > Kits</b>.</li> -<li>Select one of the predefined kits starting with <i>Boot to Qt...</i> that matches the type of your device (1).</li> -<li>Select the appropriate device in the <b>Device</b> field (2).</li> +<ol class="1" type="1"><li>Select <b>Edit > Preferences > Kits</b>.</li> +<li>Select one of the predefined kits starting with <b>Boot to Qt...</b> that matches the type of your device (1).</li> +<li>Select the appropriate device in the <b>Run device</b> field (2).</li> <li>Select <b>OK</b>.</li> </ol> <p class="centerAlign"><img src="assets/b2qt-device-in-kit.png" alt="" /></p> -<h3 id="troubleshooting-device-is-not-found">Troubleshooting: Device Is Not Found</h3> -<p>When your target device is connected to the host platform, Qt Creator should automatically detect it and the device should appear in the kit's <b>Device</b> field. If it does not appear, you can try if replugging the device or rebooting the host platform helps.</p> +<h3 id="troubleshooting-device-is-not-found">Troubleshooting: Device is not found</h3> +<p>When your target device is connected to the host platform, Qt Creator should automatically detect it and the device should appear in the kit's <b>Device</b> field. If it doesn't appear, first replug the device. If that doesn't help, then reboot the host platform.</p> +<p><b>Note: </b>In Linux, ensure that you have access to plugged in devices. For more information, see Setting Up USB Access to Embedded Devices.</p> <h2 id="creating-new-qt-quick-project">Creating New Qt Quick Project</h2> -<p>Create a new Qt Quick project with the steps in Creating Qt Quick Applications. When creating the project, you can use the default values defined in the wizard pages. In the <b>Kit Selection</b> page, select the Boot to Qt software stack kit that matches the type of your target device. The following picture illustrates how to select the kit where the device was added in Preparation of Qt Kit:</p> -<p class="centerAlign"><img src="assets/b2qt-select-kit.png" alt="" /></p><p>After you complete the steps in the project wizard, the generated Qt Quick project is automatically opened in the <b>Edit</b> mode (1).</p> -<p class="centerAlign"><img src="assets/b2qt-edit-mode-pro-file.png" alt="" /></p><p>You can see the project's structure by selecting <b>Projects</b> in the sidebar (2). If you select the <i>.pro</i> file (3) under your project, you see its content in the editor view. The last lines in the .pro file (4) define the path where your project is deployed. Qt's project wizard generates the path automatically for Qt Quick projects. For other projects, you need to define the path manually in the project file. For more information, see Deploying Qt Projects with Boot to Qt.</p> +<p>Create a new Qt Quick project with the steps in Creating Qt Quick Applications. When creating the project, you can use the default values defined in the wizard pages. In the <b>Kit Selection</b> page, select the Boot to Qt software stack kit that matches the type of your target device. The following picture illustrates how to select the kit where the device was added in Preparation of Boot to Qt Kit:</p> +<p class="centerAlign"><img src="assets/b2qt-select-kit.png" alt="" /></p> +<p>After you complete the steps in the project wizard, the generated Qt Quick project is automatically opened in the <b>Edit</b> mode (1).</p> +<p class="centerAlign"><img src="assets/b2qt-edit-mode-pro-file.png" alt="" /></p> +<p>You can see the project's structure by selecting <b>Projects</b> in the sidebar (2). If you select the <b>CMakeLists.txt</b> file (3) under your project, you see its content in the editor view. The last lines in the CMakeLists.txt file (4) define the path where your project is deployed. Qt's project wizard generates the path automatically for Qt Quick projects. For other projects, you might need to define the path manually in the CMakeLists.txt file.</p> +<p>For more information on CMake, see Build with CMake. For more information on Qt Creator configurations for Boot to Qt, see Boot to Qt Deploy Configuration.</p> -<h2 id="building-running-and-deploying-project">Building, Running, and Deploying Project</h2> +<h2 id="building-running-and-deploying-project">Building, running, and deploying project</h2> <p>Now it is time to build and run your project, and deploy it to the target device. When you run the project, Qt Creator automatically both builds it and deploys it to the device. Thus, you just need to select the <b>Run</b> button (1) in Qt Creator.</p> -<p class="centerAlign"><img src="assets/b2qt-run-button.png" alt="" /></p><p>Your project should now be running on the target device.</p> +<p class="centerAlign"><img src="assets/b2qt-run-button.png" alt="" /></p> +<p>Your project is now running on the target device.</p> +<p>For more information on CMake deployment, see Deployment in CMake documentation.</p> + +<h2 id="custom-deployment-steps">Custom deployment steps</h2> +<p>Qt Creator allows you to execute custom commands on the embedded device connected to the development host. You can add the custom commands to the deployment phase of your project.</p> +<p>Follow these steps to add a custom step to be executed during deployment:</p> +<ol class="1" type="1"><li>In Qt Creator, go to <b>Projects > Run</b> for the {Boot to Qt} version you want to customize.</li> +<li>Select <b>Add Deploy Step > Run custom remote command</b>.</li> +<li>Enter the command to be executed.</li> +</ol> </div> |
