summaryrefslogtreecommitdiffstats
path: root/bs_button/include/README
diff options
context:
space:
mode:
authormanuel <manuel@mausz.at>2020-02-04 23:33:05 +0100
committermanuel <manuel@mausz.at>2020-02-04 23:33:05 +0100
commit95e5f22a558beeaac8895400e406837656a057e0 (patch)
tree54c873c7e84b70f677f223abce32df3cd9ad3743 /bs_button/include/README
parentbc34f55c1abfca72c2ab5f6e0722b56168202366 (diff)
downloadarduino-95e5f22a558beeaac8895400e406837656a057e0.tar.gz
arduino-95e5f22a558beeaac8895400e406837656a057e0.tar.bz2
arduino-95e5f22a558beeaac8895400e406837656a057e0.zip
add bs_button
Diffstat (limited to 'bs_button/include/README')
-rw-r--r--bs_button/include/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/bs_button/include/README b/bs_button/include/README
new file mode 100644
index 0000000..194dcd4
--- /dev/null
+++ b/bs_button/include/README
@@ -0,0 +1,39 @@
1
2This directory is intended for project header files.
3
4A header file is a file containing C declarations and macro definitions
5to be shared between several project source files. You request the use of a
6header file in your project source file (C, C++, etc) located in `src` folder
7by including it, with the C preprocessing directive `#include'.
8
9```src/main.c
10
11#include "header.h"
12
13int main (void)
14{
15 ...
16}
17```
18
19Including a header file produces the same results as copying the header file
20into each source file that needs it. Such copying would be time-consuming
21and error-prone. With a header file, the related declarations appear
22in only one place. If they need to be changed, they can be changed in one
23place, and programs that include the header file will automatically use the
24new version when next recompiled. The header file eliminates the labor of
25finding and changing all the copies as well as the risk that a failure to
26find one copy will result in inconsistencies within a program.
27
28In C, the usual convention is to give header files names that end with `.h'.
29It is most portable to use only letters, digits, dashes, and underscores in
30header file names, and at most one dot.
31
32Read more about using header files in official GCC documentation:
33
34* Include Syntax
35* Include Operation
36* Once-Only Headers
37* Computed Includes
38
39https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html