platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 18:17:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarified language and fixed some grammar issues (#5085)

Browse Source
This commit is contained in:
Deen-Weible
2025-02-13 11:04:48 +00:00
committed by GitHub
parent 20e076191e
commit a71443a2ee
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
platformio/project/commands/init.py
View File

@ -201,9 +201,7 @@ new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program. find one copy will result in inconsistencies within a program.
In C, the usual convention is to give header files names that end with `.h'. In C, the convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.
Read more about using header files in official GCC documentation: Read more about using header files in official GCC documentation:
@ -222,12 +220,12 @@ def init_lib_readme(lib_dir):
fp.write( fp.write(
""" """
This directory is intended for project specific (private) libraries. This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file. PlatformIO will compile them to static libraries and link into the executable file.
The source code of each library should be placed in an own separate directory The source code of each library should be placed in a separate directory
("lib/your_library_name/[here are source files]"). ("lib/your_library_name/[Code]").
For example, see a structure of the following two libraries `Foo` and `Bar`: For example, see the structure of the following example libraries `Foo` and `Bar`:
|--lib |--lib
| | | |
@ -237,7 +235,7 @@ For example, see a structure of the following two libraries `Foo` and `Bar`:
| | |--src | | |--src
| | |- Bar.c | | |- Bar.c
| | |- Bar.h | | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html | | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| | | |
| |--Foo | |--Foo
| | |- Foo.c | | |- Foo.c
@ -249,7 +247,7 @@ For example, see a structure of the following two libraries `Foo` and `Bar`:
|--src |--src
|- main.c |- main.c
and a contents of `src/main.c`: Example contents of `src/main.c` using Foo and Bar:
``` ```
#include <Foo.h> #include <Foo.h>
#include <Bar.h> #include <Bar.h>
@ -261,8 +259,8 @@ int main (void)
``` ```
PlatformIO Library Dependency Finder will find automatically dependent The PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files. libraries by scanning project source files.
More information about PlatformIO Library Dependency Finder More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html - https://docs.platformio.org/page/librarymanager/ldf.html