Skip to content

Commit 65ea01c

Browse files
committed
Change recommendation about using PlatformIO home for configuring the project.
Because we want to retain useful comments (see #29 (review) and platformio/platformio-core#3862).
1 parent 7722740 commit 65ea01c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,7 @@ For example
5353

5454
### PlatformIO configuration
5555

56-
If you change [`platformio.ini`](platformio.ini), preferably use [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html#platformio-home).
57-
This helps to keep a common style in that file.
56+
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).
57+
In general we want to preserve useful comments in the project configuration file.
58+
Please revert unwanted deletions before committing them.
59+

0 commit comments

Comments
 (0)