docs: align README with current implementation (issue #34)#46
Merged
ShadyUnderLight merged 1 commit intomainfrom Apr 21, 2026
Merged
docs: align README with current implementation (issue #34)#46ShadyUnderLight merged 1 commit intomainfrom
ShadyUnderLight merged 1 commit intomainfrom
Conversation
Fixes documentation drift from current implementation: EN README.md: - Notes on CPU temperature: replaces 'falls back to `--`' with Apple Silicon HID priority + actionable hint behavior (no silent `--`) - Roadmap: removes 'Sparklines / history' (already implemented) and plain 'Per-process actions'; keeps only 'Per-process actions (e.g. kill, priority adjustment)' ZH README.zh-CN.md: - 关于 CPU 温度: replaces '回退显示为 `--`' with Apple Silicon HID priority + actionable hint behavior - Roadmap 想法: removes '趋势图 / 历史曲线' and plain '针对进程的操作按钮'; keeps only the clarified wording with examples All outdated lines removed; all new lines added. No code changes.
Owner
Author
|
Checked the raw diff via GitHub compare API (base=cd76c88, head=e456e66). All three stale lines are prefixed with CI is green. Requesting merge once you confirm the diff is readable. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns README and README.zh-CN.md with the current codebase (issue #34). Documentation only, no code changes.
What was removed
EN README.md:
falls back to '--' plus thermal state if no helper is availableSparklines / historyPer-process actionsZH README.zh-CN.md:
如果没有可用辅助工具，就回退显示为 '--' 和热状态趋势图 / 历史曲线针对进程的操作按钮What was added
EN README.md:
on Apple Silicon: reads HID sensors first, falls back to helper toolsshows an actionable hint ... when temperature is unavailable — no silent '--'Per-process actions (e.g. kill, priority adjustment)ZH README.zh-CN.md:
Apple Silicon 机型：优先读取 HID 传感器，辅助工具作为后备温度不可用时显示可操作提示（Intel 提示安装工具，Apple Silicon 提示检查权限），不会静默显示 '--'针对进程的操作按钮（如结束进程、优先级调整）Final state
CPU temperature section uses only actionable-hint wording. No
--fallback remains.Roadmap shows only unimplemented items with clarified examples.
2 files changed · 6 lines added · 6 lines deleted