From dad0ac4acddb154147451d6ebf60d68c00f1b818 Mon Sep 17 00:00:00 2001 From: Shelby Merrick Date: Wed, 27 Nov 2024 12:32:07 -0500 Subject: [PATCH] Added doxygen reference --- README.md | 6 ++++-- include/README | 39 --------------------------------------- src/README.md | 9 --------- 3 files changed, 4 insertions(+), 50 deletions(-) delete mode 100644 include/README delete mode 100644 src/README.md diff --git a/README.md b/README.md index 3b8cff213..3dd8a36da 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The recommended way to build ESPixelStick is with PlatformIO. Building from the - In the same status bar, click ☑️ to compile or ➡️ to compile and upload. - To build and upload the filesystem, click on the PlatformIO icon on the left bar, then click on _Project Tasks->Platform->Upload Filesystem Image_. Note that before the filesystem is built, the web pages **must** be processed. Instructions for processing the web pages are in the html [README](html/README.md). -## Directory Structure +## Project Structure ESPixelStick is now a PlatformIO project and follows the standard PlatformIO directory structure. All code should be in the releveant `src` and `include` sub-directories. Within each you will find the follwing directories: @@ -53,7 +53,9 @@ Other notable directories: - `dist` - These are the files used for creating the binary distributions. Updated binaries for flashing, ESPSFlashTool and `firmware.json` should all be updated here. - `html` - All frontend / web related code, refer to the html [README](html/README.md) for details. - `SupportingDocs` - Datasheets and protocol formats related to this project. -- `tools` = Misc tools related to this project. +- `tools` = Misc tools related to this project, refer to the tools [README](toosl/README.md) for details. + +Checkout the doxygen [source code documentation](https://forkineye.github.io/ESPixelStick/doxy/) which is generated every pipeline run. ## Supported Inputs and Outputs diff --git a/include/README b/include/README deleted file mode 100644 index 194dcd432..000000000 --- a/include/README +++ /dev/null @@ -1,39 +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/src/README.md b/src/README.md deleted file mode 100644 index 3a31a2d48..000000000 --- a/src/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# ESPixelStick Source Structure - -All code aside from the main sketch itself should reside here. The root of this directory is for core parts of the ESPixelStick code and / or pieces that should not reside in the following directories: - -- ```input``` - Show input modules should reside here and inherit from ```c_InputCommon``` as defined in ```InputCommon.hpp```. -- ```ouput``` - Show output modules should reside here and inherit from ```c_OutputCommon``` as defined in ```OutputCommon.hpp```. -- ```service``` - Auxiliary services should reside here. These include non-show critical input mechansims like FPP discovery / configuration mechanisms. - -See InputMgr and OutputMgr for adding modules to the system. \ No newline at end of file