Skip to content

Commit

Permalink
Change recommendation about using PlatformIO home for configuring the…
Browse files Browse the repository at this point in the history 
… project.

Because we want to retain useful comments (see #29 (review) and platformio/platformio-core#3862).
  • Loading branch information
@dhebbeker
dhebbeker committed May 27, 2023
1 parent 7722740 commit 65ea01c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,7 @@ For example

### PlatformIO configuration

If you change [`platformio.ini`](platformio.ini), preferably use [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html#platformio-home).
This helps to keep a common style in that file.
If you change [`platformio.ini`](platformio.ini), please note that [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html#platformio-home) [may delete comments unsolicitedly](https://github.com/platformio/platformio-core/issues/3862).
In general we want to preserve useful comments in the project configuration file.
Please revert unwanted deletions before committing them.

0 comments on commit 65ea01c

Please sign in to comment.