Skip to content

Commit

Permalink
Slight rewording of PlatformIO documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maxgerhardt committed Jul 14, 2024
1 parent c9e4284 commit f315046
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Note: With PlatformIO is genearlly used for CI on this repo. While PlatformIO ca

This project can be built, uploaded and debugged with VSCode and the PlatformIO extension. Simply clone and open this project in VSCode and have the PlatformIO extension installed.

To create a new PlatformIO firmware project based on ch32v003fun, you can either expand the available environments in the `platformio.ini` in this project [per instructions](https://github.com/cnlohr/ch32v003fun/blob/49640fbccf231191aa83c6a2bbe9d385535b2d1e/platformio.ini#L48-L53), or, simply use the [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html)'s "New Project" wizard and set "Framework" to "ch32v003fun". There are [various examples](https://github.com/Community-PIO-CH32V/platform-ch32v/tree/develop/examples/blinky-ch32v003fun).
To create a new PlatformIO firmware project based on ch32v003fun, simply use the [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html)'s "New Project" wizard and set "Framework" to "ch32v003fun". There are [various examples](https://github.com/Community-PIO-CH32V/platform-ch32v/tree/develop/examples/blinky-ch32v003fun).

![pio_proj](.github/pio_project_creation.png)

Expand All @@ -71,6 +71,8 @@ The equivalent [PlatformIO Core CLI](https://docs.platformio.org/en/latest/integ
pio init -b genericCH32V003F4P6 -O "framework = ch32v003fun"
```

If you want to add your code directly to ch32v003fun project, please expand the available environments in the `platformio.ini` as [per instructions](https://github.com/cnlohr/ch32v003fun/blob/49640fbccf231191aa83c6a2bbe9d385535b2d1e/platformio.ini#L48-L53).

Please also note that when you open this project inside PlatformIO, you can use the [project environment switcher](https://docs.platformio.org/en/latest/integration/ide/vscode.html#project-tasks) at the bottom of the VSCode taskbar to select a specific example folder. Otherwise, "Build" will by default build **all** examples.

See [platform-ch32v](https://github.com/Community-PIO-CH32V/platform-ch32v) for further details and installation of the platform.
Expand Down

0 comments on commit f315046

Please sign in to comment.