Skip to content

docs: redesign README (en/zh-CN/ja/ko) and add ESP32-S3 StopWatch firmware - #1

Merged
grpcer merged 2 commits into
mainfrom
docs/readme-and-firmware
Jun 30, 2026
Merged

docs: redesign README (en/zh-CN/ja/ko) and add ESP32-S3 StopWatch firmware#1
grpcer merged 2 commits into
mainfrom
docs/readme-and-firmware

Conversation

@grpcer

@grpcer grpcer commented Jun 30, 2026

Copy link
Copy Markdown
Owner

Summary

Two related pieces of work that round out the project for public consumption.

docs(readme): redesign the README + four-language localization

  • Reworked the README into a proper landing page: hero with the web-console screenshot and a real-device photo, badges, an architecture diagram, and 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 β€” plus Homebrew / npm / source install paths and a service-management table.
  • Corrected the supported-provider list to what ships today: Claude and Codex (subscription) and DeepSeek (api-key balance). Everything else is clearly marked as planned (previously the table listed unimplemented vendors like Cursor as if available, and the status section was stale).
  • Added full Simplified Chinese, Japanese, and Korean translations with a shared language switcher and localized anchors. Every sentence was reviewed by a native-language copy pass for accuracy and natural phrasing.

feat(firmware): bring the StopWatch firmware into the repo

  • The ESP32-S3 desk-pet firmware now lives under firmware/: 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-agnostic shared/ components (state parsing, NVS config, Wi-Fi client with mDNS discovery and /state polling, SoftAP captive-portal provisioning, DNS responder), and the embedded captive-portal page.
  • A comprehensive firmware/README.md covers the hardware, architecture, runtime data flow, and build/flash with 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.

Verification

  • npm run typecheck && lint && format:check && test && build all pass (143 tests).
  • README anchors verified against GitHub's slug algorithm (0 broken across all four languages); section headings unchanged by the copy passes.
  • No CJK characters in any source or firmware file; localized READMEs are the only files that intentionally contain non-Latin text.

πŸ€– Generated with Claude Code

grpcer and others added 2 commits June 30, 2026 20:40
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
grpcer merged commit 4ea227b into main Jun 30, 2026
2 checks passed
@grpcer
grpcer deleted the docs/readme-and-firmware branch June 30, 2026 13:40
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant