summaryrefslogtreecommitdiffstats
path: root/bs_button
diff options
context:
space:
mode:
Diffstat (limited to 'bs_button')
-rw-r--r--bs_button/.vscode/extensions.json7
-rw-r--r--bs_button/include/README39
-rw-r--r--bs_button/lib/README46
-rw-r--r--bs_button/test/README11
4 files changed, 0 insertions, 103 deletions
diff --git a/bs_button/.vscode/extensions.json b/bs_button/.vscode/extensions.json
deleted file mode 100644
index 8281e64..0000000
--- a/bs_button/.vscode/extensions.json
+++ /dev/null
@@ -1,7 +0,0 @@
1{
2 // See http://go.microsoft.com/fwlink/?LinkId=827846
3 // for the documentation about the extensions.json format
4 "recommendations": [
5 "platformio.platformio-ide"
6 ]
7} \ No newline at end of file
diff --git a/bs_button/include/README b/bs_button/include/README
deleted file mode 100644
index 194dcd4..0000000
--- a/bs_button/include/README
+++ /dev/null
@@ -1,39 +0,0 @@
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
diff --git a/bs_button/lib/README b/bs_button/lib/README
deleted file mode 100644
index 6debab1..0000000
--- a/bs_button/lib/README
+++ /dev/null
@@ -1,46 +0,0 @@
1
2This directory is intended for project specific (private) libraries.
3PlatformIO will compile them to static libraries and link into executable file.
4
5The source code of each library should be placed in a an own separate directory
6("lib/your_library_name/[here are source files]").
7
8For example, see a structure of the following two libraries `Foo` and `Bar`:
9
10|--lib
11| |
12| |--Bar
13| | |--docs
14| | |--examples
15| | |--src
16| | |- Bar.c
17| | |- Bar.h
18| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
19| |
20| |--Foo
21| | |- Foo.c
22| | |- Foo.h
23| |
24| |- README --> THIS FILE
25|
26|- platformio.ini
27|--src
28 |- main.c
29
30and a contents of `src/main.c`:
31```
32#include <Foo.h>
33#include <Bar.h>
34
35int main (void)
36{
37 ...
38}
39
40```
41
42PlatformIO Library Dependency Finder will find automatically dependent
43libraries scanning project source files.
44
45More information about PlatformIO Library Dependency Finder
46- https://docs.platformio.org/page/librarymanager/ldf.html
diff --git a/bs_button/test/README b/bs_button/test/README
deleted file mode 100644
index df5066e..0000000
--- a/bs_button/test/README
+++ /dev/null
@@ -1,11 +0,0 @@
1
2This directory is intended for PIO Unit Testing and project tests.
3
4Unit Testing is a software testing method by which individual units of
5source code, sets of one or more MCU program modules together with associated
6control data, usage procedures, and operating procedures, are tested to
7determine whether they are fit for use. Unit testing finds problems early
8in the development cycle.
9
10More information about PIO Unit Testing:
11- https://docs.platformio.org/page/plus/unit-testing.html