From 53beeeed2b31eefea83aabd0a87531d2fe62b167 Mon Sep 17 00:00:00 2001 From: Zach Nelson Date: Thu, 19 Mar 2026 23:20:50 -0500 Subject: [PATCH] chore: Removed unused PlatformIO include directory placeholder (#1417) ## Summary **What is the goal of this PR?** This change deletes include/README, which is a PlatformIO boilerplate placeholder file explaining what header files are. The include/ directory isn't used by this project (headers live in lib/ and src/), so this is just cleanup. ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**NO**_ --- include/README | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 include/README diff --git a/include/README b/include/README deleted file mode 100644 index 49819c0d..00000000 --- a/include/README +++ /dev/null @@ -1,37 +0,0 @@ - -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 convention is to give header files names that end with `.h'. - -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