aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2020-03-30 00:19:33 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2020-03-31 07:31:50 +0000
commit704d0eb8827b9f458fed8b9ddb98373965245b61 (patch)
treeeae2e2962960382885487013b0d16932df19666d
parent6419a37c8ae62b35de3c9692f9ef8a5f1274a81e (diff)
Doc: Update the MCU options screenshot
In addition, replaced the explicit list of hardware platforms with a link to the Qt for MCUs documentation. Task-numger: QTCREATORBUG-23764 Change-Id: I11b7a35a8307e3dbe832a77b43213c5049b73793 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--doc/qtcreator/images/qtcreator-mcu-options.pngbin18542 -> 14344 bytes
-rw-r--r--doc/qtcreator/src/external-resources/external-resources.qdoc21
-rw-r--r--doc/qtcreator/src/mcu/creator-mcu-dev.qdoc45
3 files changed, 35 insertions, 31 deletions
diff --git a/doc/qtcreator/images/qtcreator-mcu-options.png b/doc/qtcreator/images/qtcreator-mcu-options.png
index f01f189437..1ebe08f243 100644
--- a/doc/qtcreator/images/qtcreator-mcu-options.png
+++ b/doc/qtcreator/images/qtcreator-mcu-options.png
Binary files differ
diff --git a/doc/qtcreator/src/external-resources/external-resources.qdoc b/doc/qtcreator/src/external-resources/external-resources.qdoc
index bcc9b36640..138f8ca09f 100644
--- a/doc/qtcreator/src/external-resources/external-resources.qdoc
+++ b/doc/qtcreator/src/external-resources/external-resources.qdoc
@@ -34,3 +34,24 @@
\title macOS
\internal
*/
+
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-environment.html
+ \title Qt for MCUs - Supported Target Platforms
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-on-stm.html
+ \title Getting Started on STM
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-on-stm.html
+ \title Getting Started on STM
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-on-nxp.html
+ \title Getting Started on NXP
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-windows.html
+ \title Getting Started on Windows
+*/
diff --git a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
index 3290df28ef..c59259638d 100644
--- a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
+++ b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
@@ -47,22 +47,11 @@
Linux, and macOS. However, the Qt for MCU SDK is currently only available
for Windows.
- The following MCU boards are currently supported:
-
- \list
- \li \l{https://www.st.com/en/evaluation-tools/stm32f7508-dk.html}
- {STM32F7508-DK}
- \li \l{https://www.st.com/en/evaluation-tools/32f769idiscovery.html}
- {STM32F769I-DISCO}
- \li \l{https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1050-evaluation-kit:MIMXRT1050-EVK}
- {NXP i.MX RT1050 EVK}
- \endlist
-
- For a list of Qt for MCU reference implementations, see the Qt for MCU
- documentation.
+ For a list of Qt for MCU reference implementations, see the
+ \l{Qt for MCUs - Supported Target Platforms}{Qt for MCUs} documentation.
You use the \l{Connecting Bare Metal Devices}{Bare metal plugin} to connect
- to OpenOCD or ST-LINK Utility for debugging on MCUs.
+ to a debug server provider for debugging on MCUs.
\section1 Requirements
@@ -73,25 +62,18 @@
\li The Bare Metal plugin
\li \l{https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm}
{GNU ARM Embedded Toolchain}
- \li For STM32 boards:
- \list
- \li \l{https://www.st.com/en/embedded-software/stm32cubef7.html}
- {STM32Cube SDK}
- \li \l{https://www.st.com/en/development-tools/stm32cubeprog.html}
- {STM32Cube Programmer}
- \endlist
- \li For NXP boards:
- \list
- \li \l{https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1050-evaluation-kit:MIMXRT1050-EVK}
- {NXP EVKB-IMXRT 1050 SDK}
- \li \l{https://www.segger.com/downloads/jlink}{SEGGER JLink}
- \endlist
+ \li The hardware specific requirements vary depending on the hardware platform you are developing for.
+ For more information see:
+ \list
+ \li \l{Getting Started on NXP}
+ \li \l{Getting Started on STM}
+ \endlist
\endlist
\section1 Setting Up the Development Environment
You must download and install the required software and create connections
- between \QC and MCUs.
+ between \QC and MCUs. For more information, see \l{Getting Started on Windows}.
\section2 Enabling Bare Metal and MCU Plugins
@@ -117,7 +99,10 @@
\image qtcreator-mcu-options.png "MCU options"
\list 1
- \li In the \uicontrol {MCU board} field, select your MCU board.
+ \li In the \uicontrol {Qt for MCUs SDK} field, specify the path
+ to the directory where you installed Qt for MCUs SDK.
+ \li In the \uicontrol {Targets supported by the Qt for MCUs SDK}
+ field, select your MCU board.
\li In the \uicontrol {GNU ARM Embedded Toolchain} field,
specify the path to the directory where you installed the
tool chain.
@@ -137,8 +122,6 @@
\li In the \uicontrol {SEGGER JLink} field, specify the
path to the directory where you installed the tool.
\endlist
- \li In the \uicontrol {Qt MCU SDK} field, specify the path to the
- directory where you installed Qt MCU.
\li Select \uicontrol Apply to save the settings and to generate
a MCU device and kit.
\endlist