Skip to content

Commit

Permalink
Clarified language and fixed some grammar issues (#5085)
Browse files Browse the repository at this point in the history
  • Loading branch information
Deen-Weible authored Feb 13, 2025
1 parent 20e0761 commit a71443a
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions platformio/project/commands/init.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,7 @@ def init_include_readme(include_dir):
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.
In C, the usual 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.
In C, the convention is to give header files names that end with `.h'.
Read more about using header files in official GCC documentation:
Expand All @@ -222,12 +220,12 @@ def init_lib_readme(lib_dir):
fp.write(
"""
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
("lib/your_library_name/[here are source files]").
The source code of each library should be placed in a separate directory
("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
| |
Expand All @@ -237,7 +235,7 @@ def init_lib_readme(lib_dir):
| | |--src
| | |- Bar.c
| | |- 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.c
Expand All @@ -249,7 +247,7 @@ def init_lib_readme(lib_dir):
|--src
|- main.c
and a contents of `src/main.c`:
Example contents of `src/main.c` using Foo and Bar:
```
#include <Foo.h>
#include <Bar.h>
Expand All @@ -261,8 +259,8 @@ def init_lib_readme(lib_dir):
```
PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.
The PlatformIO Library Dependency Finder will find automatically dependent
libraries by scanning project source files.
More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html
Expand Down

0 comments on commit a71443a

Please sign in to comment.