Skip to content

docs: add README derived from DESIGN.md - #2

Merged
wine-fall merged 1 commit into
mainfrom
zachg-0702--readme
Jul 2, 2026
Merged

docs: add README derived from DESIGN.md#2
wine-fall merged 1 commit into
mainfrom
zachg-0702--readme

Conversation

@wine-fall

Copy link
Copy Markdown
Owner

What

Adds a human-facing README.md as the repo's entry point — vision, core experience, architecture (component table + key decisions), current build status, and install/run + development steps.

Source

Distilled from the master spec DESIGN.md; no design decisions introduced here, it just makes the existing spec approachable to a human reader. Install/run commands were checked against pyproject.toml ([project.scripts]) and src/murmur/app.py (CLI flags).

AI coding brief

  • Original request: "根据 DESIGN.md 写一个 readme" — produce a README grounded in the existing master spec, keep it aligned with what the doc already says.
  • Manual interventions: none on the content; user directed it to live on its own branch/PR and to reference DESIGN.md.
  • Retro: request was clear and self-contained; deriving from a single canonical spec worked well in one pass.

🤖 Generated with Claude Code

Human-facing entry point summarizing the vision, architecture, status,
and install/run steps. Distilled from the DESIGN.md master spec.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@wine-fall
wine-fall force-pushed the zachg-0702--readme branch from a2c1de7 to 1df854d Compare July 2, 2026 07:26
@wine-fall
wine-fall merged commit 0707cfb into main Jul 2, 2026
3 checks passed
@wine-fall
wine-fall deleted the zachg-0702--readme branch July 2, 2026 07:28
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