Skip to content

Commit

Permalink
Added doxygen reference
Browse files Browse the repository at this point in the history
  • Loading branch information
forkineye committed Nov 27, 2024
1 parent 7169611 commit dad0ac4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 50 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand Down
39 changes: 0 additions & 39 deletions include/README

This file was deleted.

9 changes: 0 additions & 9 deletions src/README.md

This file was deleted.

0 comments on commit dad0ac4

Please sign in to comment.