Skip to content

docs: comprehensively update README (EN + zh-CN) to v0.18.1#254

Merged
oratis merged 1 commit into
mainfrom
claude/github-readme-update-10018f
Jul 15, 2026
Merged

docs: comprehensively update README (EN + zh-CN) to v0.18.1#254
oratis merged 1 commit into
mainfrom
claude/github-readme-update-10018f

Conversation

@oratis

@oratis oratis commented Jul 15, 2026

Copy link
Copy Markdown
Owner

Why

The READMEs still described the project around v0.12, but the code is at v0.18.1 — six releases of major features were missing or contradicted. This syncs both README.md and README.zh-CN.md to the current state, cross-checked against docs/RELEASE_v0.13.0 → v0.18.1 and the source tree (not just the release notes).

Both files change symmetrically (+76 / −15 lines each).

New features documented

  • Knowledge base (Karpathy 3-layer wiki) — new section, kb_* tool rows, capability-parity + layout entries
  • Mail (read-only IMAP / Gmail-OAuth digest) — new section, lisa mail subcommand, and fixed the now-contradictory "Email deliberately skipped" table row
  • Lisa Room (ambient living space) — added to Surfaces + pixel-art GUI sections
  • Desire evolution (desire_revise / desire_close / conversation focus) — rewrote the reflection-mechanism entry
  • 九宫格 nav grid, Markdown rendering, Settings view, LISA Cloud edition, ElevenLabs voice — folded into the relevant sections

Stale info corrected

  • ~28k lines~38k (source is ~37.8k lines)
  • Renamed the stale DREAMS label to REVE (the code's current name)
  • Config table gains mail / edition / cache / effort env vars; layout gains kb/, mail/, control/, edition.ts
  • Brought the zh-CN Surfaces list to parity with EN (it was missing the Island widget + iOS Pocket entries)

Verification

  • Balanced code fences in both files; capability-parity rows have 7 columns, feature rows 2
  • New in-page anchor links (incl. the CJK ones) resolve to their headings
  • No git-tracked content beyond the two READMEs is touched

🤖 Generated with Claude Code

The READMEs described the project around v0.12; the code is at v0.18.1 —
six releases of major features were missing. Synced both to current state,
cross-checked against docs/RELEASE_v0.13→v0.18.1 and the source:

- Knowledge base (Karpathy 3-layer wiki): new section, kb_* tools,
  capability-parity + layout entries
- Mail (read-only IMAP/Gmail digest): new section, `lisa mail` subcommand,
  and fix the now-contradictory "Email deliberately skipped" table row
- Lisa Room (ambient living space): Surfaces + pixel-art GUI sections
- Desire evolution (desire_revise / desire_close / conversation focus):
  rewrote the reflection-mechanism entry
- 九宫格 nav grid, Markdown rendering, Settings view, LISA Cloud edition,
  ElevenLabs voice; env-var + layout additions (kb/, mail/, control/, edition.ts)
- Correct "~28k lines" → "~38k"; rename the stale "DREAMS" label to "REVE";
  bring the zh-CN Surfaces list to parity (it was missing Island + iOS Pocket)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@oratis
oratis merged commit ca96138 into main Jul 15, 2026
1 check passed
@oratis
oratis deleted the claude/github-readme-update-10018f branch July 15, 2026 07:39
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