@@ -201,9 +201,7 @@ def init_include_readme(include_dir):
201
201
finding and changing all the copies as well as the risk that a failure to
202
202
find one copy will result in inconsistencies within a program.
203
203
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'.
207
205
208
206
Read more about using header files in official GCC documentation:
209
207
@@ -222,12 +220,12 @@ def init_lib_readme(lib_dir):
222
220
fp .write (
223
221
"""
224
222
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.
226
224
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 ]").
229
227
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`:
231
229
232
230
|--lib
233
231
| |
@@ -237,7 +235,7 @@ def init_lib_readme(lib_dir):
237
235
| | |--src
238
236
| | |- Bar.c
239
237
| | |- 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
241
239
| |
242
240
| |--Foo
243
241
| | |- Foo.c
@@ -249,7 +247,7 @@ def init_lib_readme(lib_dir):
249
247
|--src
250
248
|- main.c
251
249
252
- and a contents of `src/main.c`:
250
+ Example contents of `src/main.c` using Foo and Bar :
253
251
```
254
252
#include <Foo.h>
255
253
#include <Bar.h>
@@ -261,8 +259,8 @@ def init_lib_readme(lib_dir):
261
259
262
260
```
263
261
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.
266
264
267
265
More information about PlatformIO Library Dependency Finder
268
266
- https://docs.platformio.org/page/librarymanager/ldf.html
0 commit comments