From e0c25d8666490f5a3b88a1cad113529bf5b4e126 Mon Sep 17 00:00:00 2001 From: Hendrik Rauh <114620133+HendrikRauh@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:23:17 +0200 Subject: [PATCH] deleted unnecessary folders / files --- README.md | 3 --- include/README | 38 -------------------------------------- lib/README | 47 ----------------------------------------------- test/README | 11 ----------- 4 files changed, 99 deletions(-) delete mode 100644 README.md delete mode 100644 include/README delete mode 100644 lib/README delete mode 100644 test/README diff --git a/README.md b/README.md deleted file mode 100644 index 07c173a..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# DMX / Artnet Interface - -Simple DIY Interface to control diff --git a/include/README b/include/README deleted file mode 100644 index e2d5e38..0000000 --- a/include/README +++ /dev/null @@ -1,38 +0,0 @@ -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 diff --git a/lib/README b/lib/README deleted file mode 100644 index bc6a01c..0000000 --- a/lib/README +++ /dev/null @@ -1,47 +0,0 @@ -This directory is intended for project specific (private) libraries. -PlatformIO will compile them to static libraries and link into executable file. - -The source code of each library should be placed in an own separate directory -("lib/your_library_name/[here are source files]"). - -For example, see a structure of the following two libraries `Foo` and `Bar`: - -|--lib -| | -| |--Bar -| | |--docs -| | |--examples -| | |--src -| | |- Bar.c -| | |- Bar.h -| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html -| | -| |--Foo -| | |- Foo.c -| | |- Foo.h -| | -| |- README --> THIS FILE -| -|- platformio.ini -|--src -|- main.c - -and a contents of `src/main.c`: - -``` -#include -#include - -int main (void) -{ - ... -} - -``` - -PlatformIO Library Dependency Finder will find automatically dependent -libraries scanning project source files. - -More information about PlatformIO Library Dependency Finder - -- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/test/README b/test/README deleted file mode 100644 index 9b1e87b..0000000 --- a/test/README +++ /dev/null @@ -1,11 +0,0 @@ - -This directory is intended for PlatformIO Test Runner and project tests. - -Unit Testing is a software testing method by which individual units of -source code, sets of one or more MCU program modules together with associated -control data, usage procedures, and operating procedures, are tested to -determine whether they are fit for use. Unit testing finds problems early -in the development cycle. - -More information about PlatformIO Unit Testing: -- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html