Skip to content

Commit d092810

Browse files
authored
Update README.md
1 parent ea959e8 commit d092810

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,25 @@
33
[![GitHub commits](https://img.shields.io/github/commits-since/stm32duino/Arduino_Core_STM32/1.3.0.svg)](https://github.com/stm32duino/Arduino_Core_STM32/compare/1.3.0...master)
44
[![Build Status](https://travis-ci.com/stm32duino/Arduino_Core_STM32.svg?branch=master)](https://travis-ci.com/stm32duino/Arduino_Core_STM32)
55

6-
**Warning**: release versioning has been changed from date versioning to semantic one. See [Release Versioning change](https://github.com/stm32duino/wiki/wiki/Release-Versioning-change)
7-
6+
* [Introduction](https://github.com/stm32duino/Arduino_Core_STM32#Introduction)<br>
87
* [Getting Started](https://github.com/stm32duino/Arduino_Core_STM32#getting-started)<br>
98
* [Boards available](https://github.com/stm32duino/Arduino_Core_STM32#boards-available)<br>
109
* [Troubleshooting](https://github.com/stm32duino/Arduino_Core_STM32#troubleshooting)<br>
1110
* [Wiki](https://github.com/stm32duino/wiki/wiki/)
1211

12+
## Introduction
13+
14+
This repo adds the support of STM32 MCU in Arduino IDE.<br>
15+
16+
This porting is based on:
17+
* [STM32Cube MCU Packages](https://www.st.com/en/embedded-software/stm32cube-mcu-packages.html) including:
18+
* The HAL hardware abstraction layer, enabling portability between different STM32 devices via standardized API calls
19+
* The Low-Layer (LL) APIs, a light-weight, optimized, expert oriented set of APIs designed for both performance and runtime efficiency
20+
* CMSIS device defintion for STM32
21+
* [CMSIS](https://developer.arm.com/embedded/cmsis): Cortex Microcontroller Software Interface Standard (CMSIS) is a vendor-independent hardware abstraction layer for the Cortex®-M processor series and defines generic tool interfaces. It has been packaged as a module for Arduino IDE: https://github.com/stm32duino/ArduinoModule-CMSIS
22+
* [GNU Arm Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm): Arm Embedded GCC compiler, libraries and other GNU tools necessary for bare-metal software development on devices based on the Arm Cortex-M. Packages are provided thanks: https://github.com/stm32duino/arm-none-eabi-gcc
23+
24+
1325
## Getting Started
1426

1527
This repo is available as a package usable with [Arduino Boards Manager](https://www.arduino.cc/en/guide/cores).
@@ -21,7 +33,9 @@ https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_ind
2133

2234
For full instructions on using the "**Boards Manager**", see the [Getting Started](https://github.com/stm32duino/wiki/wiki/Getting-Started) page.
2335

24-
For advanced user, you can use the repository: see the [Using git repository](https://github.com/stm32duino/wiki/wiki/Using-git-repository) page.
36+
Advanced user can use the repository to benefit from the latest development. See the [Using git repository](https://github.com/stm32duino/wiki/wiki/Using-git-repository) page.
37+
38+
User can add a STM32 based board following this [wiki](https://github.com/stm32duino/wiki/wiki/Add-a-new-variant-(board)).
2539

2640
## Boards available
2741
### Current release

0 commit comments

Comments
 (0)