Skip to content

docs: Clarify relationship to PlatformIO in README.md #1413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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)
Expand Down