jeans/WLED
1
0
Fork 0
mirror of https://github.com/wled/WLED.git synced 2026-04-27 01:22:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify handling of generated html_*.h files

Browse Source 
Updated instructions regarding generated html_*.h files to clarify that they should not be committed, and they don't need to be re-generated in any PR.
This commit is contained in:
Frank Möhle
2026-03-13 17:29:07 +01:00
committed by GitHub
parent 64f3aa96dd
commit 3244d0f593
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/copilot-instructions.md vendored
View File

@@ -85,7 +85,7 @@ wled00/ # Main firmware source (C++)
│ ├── settings*.htm # Settings pages
│ └── *.js/*.css # Frontend resources
├── *.cpp/*.h # Firmware source files
└── html_*.h # Generated embedded web files (DO NOT EDIT)
└── html_*.h # Auto-generated embedded web files (DO NOT EDIT, DO NOT COMMIT)
tools/ # Build tools (Node.js)
├── cdata.js # Web UI build script
└── cdata-test.js # Test suite
@@ -149,9 +149,11 @@ package.json # Node.js dependencies and scripts
## Important Notes
- **DO NOT edit `wled00/html_*.h` files** - they are auto-generated
- **Always commit both source files AND generated html_*.h files**
- **Always commit source files**
- **do not commit generated html_*.h files**
- **Web UI must be built before firmware compilation**
- **Test web interface manually after any web UI changes**
- When reviewing a PR, the PR author does not need to update/commit generated html_*.h files - these files will be auto-generated when building the firmware binary.
- **Use VS Code with PlatformIO extension for best development experience**
- **Hardware builds require appropriate ESP32/ESP8266 development board**