summaryrefslogtreecommitdiff
path: root/code/main/teensy_player/include/README
diff options
context:
space:
mode:
authorAbel Tim <git@abeltim.com>2025-05-27 14:57:06 +0200
committerAbel Tim <git@abeltim.com>2025-05-27 14:57:06 +0200
commitc3b4f159df6b52ac8045fbadaf424a88a2b329a8 (patch)
tree9af7e3ddf529d2aeb5e17ce39f9a824327913688 /code/main/teensy_player/include/README
parente836ff283a67c7b43a4506f8a6654be5e8500648 (diff)
downloadrobotica-c3b4f159df6b52ac8045fbadaf424a88a2b329a8.tar.gz
robotica-c3b4f159df6b52ac8045fbadaf424a88a2b329a8.zip
zephyr
Multi-line description of commit, feel free to be detailed. Signed-off-by: Abel Tim <git@abeltim.com>
Diffstat (limited to 'code/main/teensy_player/include/README')
-rw-r--r--code/main/teensy_player/include/README37
1 files changed, 0 insertions, 37 deletions
diff --git a/code/main/teensy_player/include/README b/code/main/teensy_player/include/README
deleted file mode 100644
index 49819c0..0000000
--- a/code/main/teensy_player/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