Expand local firmware catalog docs for new sibling module demos.
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
10
README.md
10
README.md
@@ -8,7 +8,7 @@ Stack: **Next.js 15** · **Web Serial** · **esp-web-tools** · **next-intl** ·
|
||||
|---|---|
|
||||
| Locales | English (default) `/en` · 中文 `/zh` only when Chinese is detected (browser/OS `Accept-Language`, `navigator.languages`, Intl locale, or prior cookie) |
|
||||
| Boards | CYD 2.8\" available · 2.4\" / 3.5\" / S3 Touch shown as Soon |
|
||||
| Catalog | Searchable card grid · detail pane · media-ready |
|
||||
| Catalog | Searchable card grid · detail pane · HTML UI previews (sync sibling `firmware/*`) |
|
||||
| SEO | `generateMetadata`, Open Graph, `/sitemap.xml`, `/robots.txt` |
|
||||
| Flash | `0x1000` bootloader · `0x8000` partitions · `0xe000` boot_app0 · `0x10000` firmware |
|
||||
|
||||
@@ -109,10 +109,14 @@ lib/firmware.ts # discovery + meta.json
|
||||
messages/ # en.json · zh.json
|
||||
```
|
||||
|
||||
## Catalog snapshot (local)
|
||||
|
||||
After `npm run sync:firmware`, the flasher discovers every sibling package under `../**/firmware/<variant>/` that has the four bins. Current set includes sensor dashboards (climate / GY30 / SGP30 / LD2420), Pomodoro / photo album, plus module demos (buzzer, button, touch button, PIR, whistle, HW-069, HW-269, KY-009, LCD1602A, BLE, WiFi Prov).
|
||||
|
||||
## 中文说明
|
||||
|
||||
本机:`npm run dev` → http://localhost:3000 ,右上角切语言。先选板型(目前仅 2.8\" 可用),再在卡片目录里选固件刷写。
|
||||
本机:`npm run sync:firmware` 后 `npm run dev` → http://localhost:3000 (或其它端口),右上角切语言。先选板型(目前仅 2.8\" 可用),再在卡片目录里选固件刷写。
|
||||
|
||||
为固件增加封面:在对应 `firmware/<variant>/media/preview.html`(及可选 `meta.json`)即可,卡片用 HTML iframe 预览,无需改前端。
|
||||
|
||||
公网部署与服务器账号见 **[DEPLOY.md](./DEPLOY.md)**。
|
||||
公网部署与服务器账号见 **[DEPLOY.md](./DEPLOY.md)**。本次仅更新本地,未部署公网。
|
||||
|
||||
Reference in New Issue
Block a user