docs: redesign README (en/zh-CN/ja/ko) and add ESP32-S3 StopWatch firmware - #1
Merged
Conversation
Bring the round-screen ESP32-S3 desk-pet firmware into the public repo so the device half of Tokpet is open alongside the companion: - apps/stopwatch: the M5Stack StopWatch board app β BSP for the CO5300 466x466 round AMOLED (QSPI), CST820 touch, the I2C power/IO expander, and two buttons, plus the LVGL "halo cat" UI. - shared/: board-agnostic components reused across boards β /state JSON parsing, NVS-backed config, the Wi-Fi client with mDNS discovery and /state polling, SoftAP captive-portal provisioning, and a DNS responder. - provisioning-web/: the captive-portal page embedded into the firmware. - firmware/README.md: hardware, architecture, runtime data flow, and build/flash instructions for ESP-IDF 5.5. All comments are English-only. Build output, fetched managed components, and the generated sdkconfig are git-ignored; firmware/ is excluded from the JS toolchain's Prettier pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rework the README into a proper project landing page: - Hero with the web-console screenshot, a real-device photo, badges, and a language switcher; an architecture diagram; icon-marked sections. - A Quick start that actually tells users how to view it: open the console at http://localhost:4717 (or `tokpet open`), with the GET /state feed one path over. Homebrew / npm / source install paths and a service table. - Correct the supported-provider list to what ships today β Claude and Codex (subscription) and DeepSeek (api-key balance) β and clearly mark the rest as planned, instead of listing unimplemented vendors as if available. - Full Simplified Chinese, Japanese, and Korean translations with a shared language switcher and localized anchors. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
grpcer
added a commit
that referenced
this pull request
Jun 30, 2026
docs: redesign README (en/zh-CN/ja/ko) and add ESP32-S3 StopWatch firmware
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
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.
Summary
Two related pieces of work that round out the project for public consumption.
docs(readme): redesign the README + four-language localizationhttp://localhost:4717(ortokpet open), with theGET /statefeed one path over β plus Homebrew / npm / source install paths and a service-management table.subscription) and DeepSeek (api-keybalance). Everything else is clearly marked as planned (previously the table listed unimplemented vendors like Cursor as if available, and the status section was stale).feat(firmware): bring the StopWatch firmware into the repofirmware/: the M5Stack StopWatch board app (CO5300 466Γ466 round AMOLED over QSPI, CST820 touch, the I2C power/IO expander, two buttons), the LVGL "halo cat" UI, the board-agnosticshared/components (state parsing, NVS config, Wi-Fi client with mDNS discovery and/statepolling, SoftAP captive-portal provisioning, DNS responder), and the embedded captive-portal page.firmware/README.mdcovers the hardware, architecture, runtime data flow, and build/flash with ESP-IDF 5.5.sdkconfigare git-ignored;firmware/is excluded from the JS toolchain's Prettier pass.Verification
npm run typecheck && lint && format:check && test && buildall pass (143 tests).π€ Generated with Claude Code