summaryrefslogtreecommitdiff
path: root/code/debug/camera/communication/rx_teensy/include/README
diff options
context:
space:
mode:
authorAbel Tim <git@abeltim.com>2025-05-12 20:56:11 +0200
committerAbel Tim <git@abeltim.com>2025-05-12 20:56:11 +0200
commitc007afbd2c1339d58a582a905f07a5b39ddaafbd (patch)
tree367431b4c5095442cc7b714f4849ef35d206bff2 /code/debug/camera/communication/rx_teensy/include/README
parent1fb85fcf2582320cc41621b90adbb0a1aef551e0 (diff)
downloadrobotica-c007afbd2c1339d58a582a905f07a5b39ddaafbd.tar.gz
robotica-c007afbd2c1339d58a582a905f07a5b39ddaafbd.zip
cam comm + readme -4
Multi-line description of commit, feel free to be detailed. Signed-off-by: Abel Tim <git@abeltim.com>
Diffstat (limited to 'code/debug/camera/communication/rx_teensy/include/README')
-rw-r--r--code/debug/camera/communication/rx_teensy/include/README37
1 files changed, 37 insertions, 0 deletions
diff --git a/code/debug/camera/communication/rx_teensy/include/README b/code/debug/camera/communication/rx_teensy/include/README
new file mode 100644
index 0000000..49819c0
--- /dev/null
+++ b/code/debug/camera/communication/rx_teensy/include/README
@@ -0,0 +1,37 @@
+
+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