docs: hero light-show GIFs + digital-twin framing in README#2
Merged
Conversation
Lead the README with the two PGA2350 carrier hero animations — the ghostshow firmware's effects.c light show on each board's 24-pixel WS2812 matrix, the same WS2812 bitstream this engine produces while stepping the Hazard3 core through the RP2350 bootrom, SIO, timers, and PIO. Add a "Why a digital twin" section linking the engine to the carrier it was built to bring up, and reuse the GIFs under docs/. Signed-off-by: Pratheek Balakrishna <pratheekb96@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Massively updates the README to give the engine a hero and a "why".
Hero animations (reused from the carrier repo). Two looping GIFs lead the README — the main and mini PGA2350 carriers running the
ghostshowfirmware'seffects.clight show on their 24-pixel WS2812 ghost matrix, auto-rotating in the RP2350 dashboard HUD. The caption makes the connection explicit: every WS2812 bit driving that show is produced by this engine stepping the Hazard3 core through the RP2350 bootrom, SIO, timers, and PIO.New "Why a digital twin" section. Frames the engine as the brain inside the carrier's simulation — fail in software, not silicon — and links the Vite/TS dashboard that drives it.
All existing technical content (lineage & credit, the 19 RISC-V fixes, quick start, layout) is preserved verbatim. GIFs live under
docs/and are excluded from the npm package (files: ["dist"]).No code changes — README + assets only.