Skip to content

Commit a71443a

Browse files
authored
Clarified language and fixed some grammar issues (platformio#5085)
1 parent 20e0761 commit a71443a

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

platformio/project/commands/init.py

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,7 @@ def init_include_readme(include_dir):
201201
finding and changing all the copies as well as the risk that a failure to
202202
find one copy will result in inconsistencies within a program.
203203
204-
In C, the usual convention is to give header files names that end with `.h'.
205-
It is most portable to use only letters, digits, dashes, and underscores in
206-
header file names, and at most one dot.
204+
In C, the convention is to give header files names that end with `.h'.
207205
208206
Read more about using header files in official GCC documentation:
209207
@@ -222,12 +220,12 @@ def init_lib_readme(lib_dir):
222220
fp.write(
223221
"""
224222
This directory is intended for project specific (private) libraries.
225-
PlatformIO will compile them to static libraries and link into executable file.
223+
PlatformIO will compile them to static libraries and link into the executable file.
226224
227-
The source code of each library should be placed in an own separate directory
228-
("lib/your_library_name/[here are source files]").
225+
The source code of each library should be placed in a separate directory
226+
("lib/your_library_name/[Code]").
229227
230-
For example, see a structure of the following two libraries `Foo` and `Bar`:
228+
For example, see the structure of the following example libraries `Foo` and `Bar`:
231229
232230
|--lib
233231
| |
@@ -237,7 +235,7 @@ def init_lib_readme(lib_dir):
237235
| | |--src
238236
| | |- Bar.c
239237
| | |- Bar.h
240-
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
238+
| | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
241239
| |
242240
| |--Foo
243241
| | |- Foo.c
@@ -249,7 +247,7 @@ def init_lib_readme(lib_dir):
249247
|--src
250248
|- main.c
251249
252-
and a contents of `src/main.c`:
250+
Example contents of `src/main.c` using Foo and Bar:
253251
```
254252
#include <Foo.h>
255253
#include <Bar.h>
@@ -261,8 +259,8 @@ def init_lib_readme(lib_dir):
261259
262260
```
263261
264-
PlatformIO Library Dependency Finder will find automatically dependent
265-
libraries scanning project source files.
262+
The PlatformIO Library Dependency Finder will find automatically dependent
263+
libraries by scanning project source files.
266264
267265
More information about PlatformIO Library Dependency Finder
268266
- https://docs.platformio.org/page/librarymanager/ldf.html

0 commit comments

Comments
 (0)