From b58024acebf96a50079c55e83d45e084e76ec310 Mon Sep 17 00:00:00 2001 From: Brian 'Redbeard' Harrington Date: Sat, 5 Jun 2021 16:51:00 -0700 Subject: [PATCH] docs: Clarify relationship in PlatformIO Commit ab2e8a9ad4 introduced the ability to consume this project as a library/package within the project PlatformIO. This attempts to clarify (to the casual reader) where this Arduino core exists within the relationship between the projects. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3470b1a70..188d8a8bbc 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,9 @@ This porting is based on: ## Getting Started -This repo is available as a package usable with [Arduino Boards Manager](https://www.arduino.cc/en/guide/cores). +This repo is available as a package usable with [Arduino Boards Manager](https://www.arduino.cc/en/guide/cores) and [PlatformIO](https://docs.platformio.org/en/latest/platforms/ststm32.html#switching-between-arduino-cores). + +### Arduino IDE Add this link in the "*Additional Boards Managers URLs*" field: @@ -44,6 +46,18 @@ Advanced user can use the repository to benefit from the latest development. See User can add a STM32 based board following this [wiki](https://github.com/stm32duino/wiki/wiki/Add-a-new-variant-(board)). +### PlatformIO + +In your project, set your environment to use the `platform` setting `ststm32` and the `framework` setting `arduino`, e.g: + +```dosini +[env] +platform = ststm32 +framework = arduino +``` + +Behind the scenes this will create a dependency on the "development platform" ST STM32 ([`ststm32`](https://docs.platformio.org/en/latest/platforms/ststm32.html)) and the framework package `framework-arduinoststm32` (the PlatformIO name of this library as noted in [/package.json](https://github.com/stm32duino/Arduino_Core_STM32/blob/master/package.json)). This repository should not be confused with the `ststm32` "development platform" which is located at [https://github.com/platformio/platform-ststm32/]. + ## Supported boards - [Nucleo 144 boards](#nucleo-144-boards)