From 844aeaf0a685180633107e89b9d28023ae05bd78 Mon Sep 17 00:00:00 2001 From: "Matthias P. Braendli" Date: Thu, 18 May 2023 13:42:52 +0200 Subject: Move tracker into subdir --- tracker-stm32/include/README | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 tracker-stm32/include/README (limited to 'tracker-stm32/include/README') diff --git a/tracker-stm32/include/README b/tracker-stm32/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/tracker-stm32/include/README @@ -0,0 +1,39 @@ + +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 -- cgit v1.2.3