Skip to content

Commit 202cf04

Browse files
committed
[DOC] Highlight important info in README.md
1 parent 9cc51b1 commit 202cf04

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
![latest tag](https://img.shields.io/github/v/tag/STMicroelectronics/STM32CubeU5.svg?color=brightgreen)
44

5-
## Important note
6-
7-
This repository has been created using the `git submodule` command. Please refer to the ["How to use"](README.md#how-to-use) section for more details.
5+
> [!IMPORTANT]
6+
> This repository has been created using the `git submodule` command. Please refer to the ["How to use"](README.md#how-to-use) section for more details.
87
98
## Overview
109

@@ -21,21 +20,24 @@ This repository has been created using the `git submodule` command. Please refer
2120

2221
The **STM32CubeU5 MCU Package** projects are directly running on the STM32U5 series boards. You can find in each Projects/*Board name* directories a set of software projects (Applications, Demonstration, Examples).
2322

24-
## Some middleware libraries and projects are unavailable in this repository
25-
26-
In this repository, the middleware libraries listed below **along with** [this](Projects/README.md#list-of-unavailable-projects) list of projects (demos, applications, and examples) using them, are **not available** as they (the middleware libraries) are subject to some restrictive license terms requiring the user's approval via a "click thru" procedure.
27-
* `./Middlewares/ST/SE_STSAFEA_API`
28-
* `./Middlewares/ST/STSAFE_A1xx`
29-
30-
If needed, they can be found inside the full firmware package available on our website `st.com` and downloadable from [here](https://www.st.com/content/st_com/en/products/embedded-software/mcu-mpu-embedded-software/stm32-embedded-software/stm32cube-mcu-mpu-packages/stm32cubeu5.html#get-software). You will be prompted to login or to register in case you have no account.
23+
> [!NOTE]
24+
> ## Some middleware libraries and projects are unavailable in this repository
25+
>
26+
> In this repository, the middleware libraries listed below **along with** [this](Projects/README.md#list-of-unavailable-projects) list of projects (demos,
27+
> applications, and examples) using them, are **not available** as they (the middleware libraries) are subject to some restrictive license terms requiring the user's
28+
> approval via a "click thru" procedure.
29+
> * `./Middlewares/ST/SE_STSAFEA_API`
30+
> * `./Middlewares/ST/STSAFE_A1xx`
31+
>
32+
> If needed, they can be found inside the full firmware package available on our website `st.com` and downloadable from [here](https://www.st.com/content/st_com/en/products/embedded-software/mcu-mpu-embedded-software/stm32-embedded-software/stm32cube-mcu-mpu-packages/stm32cubeu5.html#get-software). You will be prompted to login or to register in case you have no account.
3133
3234
## Release note
3335

3436
Details about the content of this release are available in the release note [here](https://htmlpreview.github.io/?https://github.com/STMicroelectronics/STM32CubeU5/blob/master/Release_Notes.html).
3537

3638
## How to use
3739

38-
This repository has been created using the `git submodule` command. Please check the instructions below for proper use. Please check also the [notes](README.md#notes) at the end of this section for further information.
40+
This repository has been created using the `git submodule` command. Please check the instructions below for proper use. Please check also **the notes at the end of this section** for further information.
3941

4042
1. To **clone** this repository along with the linked submodules, option `--recursive` has to be specified as shown below.
4143

@@ -62,11 +64,10 @@ git checkout vX.Y.Z # Specify the targeted vX.Y.Z version
6264
git clone --recursive --depth 1 --branch vX.Y.Z https://github.com/STMicroelectronics/STM32CubeU5.git
6365
```
6466

65-
#### Notes
66-
67-
* The latest version of this firmware available on GitHub may be **ahead** of the one available on [st.com](https://www.st.com/en/microcontrollers-microprocessors/stm32-32-bit-arm-cortex-mcus.html) or via [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html). This is due to the **rolling release** process deployed on GitHub. Please refer to [this](https://github.com/STMicroelectronics/STM32Cube_MCU_Overall_Offer/discussions/21) post for more details.
68-
* Option `--depth 1` specified in instruction (4) above is **not** mandatory. It may be useful to skip downloading all previous commits up to the one corresponding to the targeted version.
69-
* If GitHub "Download ZIP" option is used instead of the `git clone` command, then the different submodules have to be collected and added **manually**.
67+
> [!NOTE]
68+
> * The latest version of this firmware available on GitHub may be **ahead** of the one available on [st.com](https://www.st.com/en/microcontrollers-microprocessors/stm32-32-bit-arm-cortex-mcus.html) or via [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html). This is due to the **rolling release** process deployed on GitHub. Please refer to [this](https://github.com/STMicroelectronics/STM32Cube_MCU_Overall_Offer/discussions/21) post for more details.
69+
> * Option `--depth 1` specified in instruction (4) above is **not** mandatory. It may be useful to skip downloading all previous commits up to the one corresponding to the targeted version.
70+
> * If GitHub "Download ZIP" option is used instead of the `git clone` command, then the different submodules have to be collected and added **manually**.
7071
7172
## Boards available
7273
* STM32U5

0 commit comments

Comments
 (0)