Skip to content

docs: align README with current implementation (issue #34)#45

Closed
ShadyUnderLight wants to merge 1 commit intomainfrom
feature/issue34-readme-v2
Closed

docs: align README with current implementation (issue #34)#45
ShadyUnderLight wants to merge 1 commit intomainfrom
feature/issue34-readme-v2

Conversation

@ShadyUnderLight
Copy link
Copy Markdown
Owner

Summary

Aligns README and README.zh-CN.md with the current codebase (issue #34 — README 已出现轻微能力漂移). Docs-only, no code changes.

Contradictions fixed

1. CPU temperature fallback description (both EN + ZH)

  • REMOVED: "falls back to -- plus thermal state" / "回退显示为 --"
  • ADDED: Apple Silicon HID sensor priority ("reads HID sensors first, falls back to helper tools")
  • ADDED: actionable hint behavior ("shows an actionable hint when temperature is unavailable — no silent --")

2. Roadmap still listed Sparklines as unimplemented (both EN + ZH)

  • REMOVED: "Sparklines / history" / "趋势图 / 历史曲线" (already implemented — SparklineView + *History arrays exist)
  • REWORDED: "Per-process actions" → "Per-process actions (e.g. kill, priority adjustment)" to clarify what is NOT yet done

What was already correct (from issue #33)

The Features list already reads "Memory pressure (system-wide active + inactive + wired + compressor)" — no change needed there.

Diff

Only 2 files changed, 6 lines added / 6 lines removed — all documentation.

Three contradictions fixed:

1. CPU temperature fallback section (README.md + zh-CN):
   REMOVED: 'falls back to `--` plus thermal state'
   ADDED: Apple Silicon HID sensor priority + actionable hint behavior
   (the `--` fallback description was incorrect — app shows hint instead)

2. Roadmap (README.md + zh-CN):
   REMOVED: 'Sparklines / history' / '趋势图 / 历史曲线'
   (already implemented via SparklineView + *History arrays, moved to Features)
   REWORDED: 'Per-process actions' → 'Per-process actions (e.g. kill, priority adjustment)'
   (clarifies what is NOT yet implemented vs what is)

3. zh-CN CPU temperature section additionally updated:
   ADDED: Apple Silicon HID sensor priority
   ADDED: actionable hint behavior description

No code changes — documentation only.
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