summaryrefslogtreecommitdiffstats
path: root/rgbtv_light/lib/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'rgbtv_light/lib/readme.txt')
-rw-r--r--rgbtv_light/lib/readme.txt36
1 files changed, 36 insertions, 0 deletions
diff --git a/rgbtv_light/lib/readme.txt b/rgbtv_light/lib/readme.txt
new file mode 100644
index 0000000..3f9e008
--- /dev/null
+++ b/rgbtv_light/lib/readme.txt
@@ -0,0 +1,36 @@
1
2This directory is intended for the project specific (private) libraries.
3PlatformIO will compile them to static libraries and link to executable file.
4
5The source code of each library should be placed in separate directory, like
6"lib/private_lib/[here are source files]".
7
8For example, see how can be organized `Foo` and `Bar` libraries:
9
10|--lib
11| |--Bar
12| | |--docs
13| | |--examples
14| | |--src
15| | |- Bar.c
16| | |- Bar.h
17| |--Foo
18| | |- Foo.c
19| | |- Foo.h
20| |- readme.txt --> THIS FILE
21|- platformio.ini
22|--src
23 |- main.c
24
25Then in `src/main.c` you should use:
26
27#include <Foo.h>
28#include <Bar.h>
29
30// rest H/C/CPP code
31
32PlatformIO will find your libraries automatically, configure preprocessor's
33include paths and build them.
34
35More information about PlatformIO Library Dependency Finder
36- http://docs.platformio.org/en/stable/librarymanager/ldf.html