From e456e66b488ee7be98263a24f7cd71f4d1cea6a7 Mon Sep 17 00:00:00 2001 From: LMZ Date: Tue, 21 Apr 2026 19:15:50 +0800 Subject: [PATCH] docs: align README with current implementation (issue #34) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- README.md | 6 +++--- README.zh-CN.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 573de96..1629b9c 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,8 @@ GitHub Actions now builds the Swift package and app bundle automatically on push ## Notes on CPU temperature macOS does not expose CPU temperature through a stable public API for normal apps. This app therefore: - tries to read temperature from installed helper tools such as `osx-cpu-temp` or `istats` -- falls back to `--` plus thermal state if no helper is available +- on Apple Silicon: reads HID sensors first, falls back to helper tools +- shows an actionable hint (e.g. install hint on Intel, permission check on Apple Silicon) when temperature is unavailable — no silent `--` - does **not** require sudo or private entitlements ## Known limitations @@ -71,8 +72,7 @@ macOS does not expose CPU temperature through a stable public API for normal app - The app is still being polished for wider public release ## Roadmap ideas -- Sparklines / history -- Per-process actions +- Per-process actions (e.g. kill, priority adjustment) - Better sensor integrations - Further performance tuning diff --git a/README.zh-CN.md b/README.zh-CN.md index fd0bfb6..c062ee3 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -61,7 +61,8 @@ GitHub Actions 已经配置好,会在 push、pull request 和版本 tag 时自 ## 关于 CPU 温度 macOS 没有为普通应用提供稳定的公开 CPU 温度 API,所以这个项目会: - 尝试读取已安装的辅助工具,例如 `osx-cpu-temp` 或 `istats` -- 如果没有可用辅助工具,就回退显示为 `--` 和热状态 +- Apple Silicon 机型:优先读取 HID 传感器,辅助工具作为后备 +- 温度不可用时显示可操作提示(Intel 提示安装工具,Apple Silicon 提示检查权限),不会静默显示 `--` - **不需要** sudo,也不依赖私有 entitlement ## 已知限制 @@ -70,8 +71,7 @@ macOS 没有为普通应用提供稳定的公开 CPU 温度 API,所以这个 - 这个应用还在继续打磨,离更成熟的公开版本还有一些工作 ## Roadmap 想法 -- 趋势图 / 历史曲线 -- 针对进程的操作按钮 +- 针对进程的操作按钮(如结束进程、优先级调整) - 更好的传感器集成 - 进一步的性能优化