From f383ecc15eded369addd5cd63b14cdf1cf12e6e2 Mon Sep 17 00:00:00 2001 From: fvanroie <15969459+fvanroie@users.noreply.github.com> Date: Fri, 12 Mar 2021 04:10:10 +0100 Subject: [PATCH] Update README --- include/README | 37 +------------------------------------ lib/README | 2 +- 2 files changed, 2 insertions(+), 37 deletions(-) diff --git a/include/README b/include/README index 194dcd43..794e54d7 100644 --- a/include/README +++ b/include/README @@ -1,39 +1,4 @@ This directory is intended for project header files. -A header file is a file containing C declarations and macro definitions -to be shared between several project source files. You request the use of a -header file in your project source file (C, C++, etc) located in `src` folder -by including it, with the C preprocessing directive `#include'. - -```src/main.c - -#include "header.h" - -int main (void) -{ - ... -} -``` - -Including a header file produces the same results as copying the header file -into each source file that needs it. Such copying would be time-consuming -and error-prone. With a header file, the related declarations appear -in only one place. If they need to be changed, they can be changed in one -place, and programs that include the header file will automatically use the -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 -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. - -Read more about using header files in official GCC documentation: - -* Include Syntax -* Include Operation -* Once-Only Headers -* Computed Includes - -https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html +The header files in this folder configure the different components of HASP, LVGL and paho. \ No newline at end of file diff --git a/lib/README b/lib/README index 6debab1e..79cec710 100644 --- a/lib/README +++ b/lib/README @@ -1,5 +1,5 @@ -This directory is intended for project specific (private) libraries. +This directory is intended for project specific (customized) libraries. PlatformIO will compile them to static libraries and link into executable file. The source code of each library should be placed in a an own separate directory