humanize-readme

Humanize README

读取当前的 README.md，检查其中是否存在 AI 腔的模式，然后用直接、诚恳、自然的语气重写。

工作流程

步骤 1 — 阅读 README

使用传入的路径；如果没有传入路径，则默认为 README.md：

cat <readme-path>   # e.g. cat docs/README.md — falls back to cat README.md

同时检查项目的实际情况（重写时使用具体信息，而非泛泛而谈）：

cat package.json 2>/dev/null | head -20
cat pyproject.toml 2>/dev/null | head -15
ls src/ 2>/dev/null | head -10

步骤 2 — 检查 AI 腔

阅读 references/slop-patterns.md，查看完整列表。在 README 中标记以下内容：

明显的 AI 腔模式：

• 禁用的流行词：seamlessly、robust、scalable、leverage、cutting-edge、comprehensive、empower、intuitive、powerful、game-changer
• 2026 年常见的模糊说法和填充语：「it's worth noting」、「let's explore」、「this is designed to」、「makes it easy to」、「enables developers to」、「ensures」、「has been designed」
• 以「In today's...」、「This powerful tool...」、「This repository aims to...」开头的泛泛引言
• 使用空洞形容词的功能列表：「Blazing fast」、「Enterprise-grade」、「Intuitive API」
• 看似面面俱到，却没有坦言不足
• 对项目进行哲学式总结的结尾
• 句子长度整齐划一 — 每句话的节奏都相同（节奏变化检查）
• 缺少个人语气 — 没有说明项目为何存在，没有坦言局限，也没有提及取舍

步骤 3 — 重写

按照以下规则重写 README：

语气：

• 像喝咖啡时介绍项目那样写——直接、具体，稍微随意一些
• 使用实际的技术名称（不要说「现代技术」或「业界标准工具」）
• 代码块、命令和链接保持原样
• 保留原有结构（各章节），但重写其中的文字

各章节要求：

• 项目描述 / 引言 — 用一两句话说明它的作用和存在的原因。不要使用夸张说法。
• 功能 — 去掉形容词，补充具体信息。不要说「快速」，而应在已知的情况下给出实际数字；否则就直接说明功能。
• 安装 / 使用 — 如果写得已经清楚，就保持原样；删去诸如「欢迎开始入门……」之类的填充内容。
• 为什么选择这个项目 — 如果有此章节且内容泛泛而谈，就改写为真实原因，或直接删除。
• 贡献 / 结尾 — 删除「给仓库点个星」、空谈理念或冗长的贡献指南。

语气规则：

• 如实说明不足：「未经 Windows 测试」、「仍处于实验阶段」、「在我的机器上能运行」
• 句子长短要有变化，不要整齐划一
• 不要添加表情符号；原文已有时也要尽量减少
• 除非确有必要，否则不要使用感叹号

不要：

• 添加原文没有的内容——只重写已有内容
• 改变技术准确性——保留原有说法，只去掉浮夸内容
• 为了简短而简短，导致内容难以理解——清晰比简洁更重要
• 修改徽章行（[![...](...)](#) 行）——CI 徽章、版本徽章和许可证徽章都必须保持原样

步骤 4 — 输出

将完整重写后的 README 放在单个带围栏的 Markdown 代码块中输出，以便直接复制。

代码块前简要说明你做了哪些修改（最多 2–3 个要点）。

完整禁用短语列表和修改前后的示例： references/slop-patterns.md