KorroAi/readme-roast

# 🔥 README-ROAST

你的 README 在骗你。是时候来次干预了。

**README-ROAST** 是一个用来吐槽你 README 的 [Claude Code](https://claude.ai/code) 技能。8 种人设。诚实度评分。一句话总结。徽章。一张截图就能装下。既毒舌又实用。

## 快速开始 ``` # 安装 (Claude Code skill) # 放置在 ~/.claude/skills/readme-roast/ # 然后： /readme-roast # Roast current directory (random persona) /readme-roast github.com/vercel/next.js # Roast a remote repo /readme-roast --ramsay # Gordon Ramsay yells at your README /readme-roast --self # The skill roasts itself. Flex. ``` ## 8 种人设 你永远不知道谁会出现。 | 人设 | 气质 | 标志性风格 | |---------|------|-----------| | 🍳 **Gordon Ramsay** | 厨师狂怒 | "你的安装说明完全是生的 (RAW)。" | | 🌿 **David Attenborough** | 自然纪录片 | "在这里，我们看到一个初级开发者正在膨胀它的 README……" | | 🕵️ **侦探** | 黑色电影私家侦探 | "benchmark 文件夹是空的。有人清理过。" | | 🧊 **前任** | 有毒前任 | "‘生产就绪 (Production-ready)。’ 你上个项目也是这么说的。" | | 👶 **三岁小孩** | 无休止地问为什么 | "你说它是轻量级的。为什么？847 个依赖。为什么？" | | 🎤 **单口喜剧演员** | Netflix 专场 | "‘协同效应 (Synergistic)。’ [停顿] 在一个 TODO 应用里。" | | 🗿 **粗野主义者** | 最多 5 个词 | "这段话毫无意义。" | | 🔥 **潮人** | Z 世代俚语 | "你的安装步骤？一般般。功能列表？永远的神。fr fr。" | ## 你能得到什么 每次吐槽都会生成： | 输出内容 | 描述 | |--------|-------------| | **诚实度评分** (0–100) | 你的 README 到底有多真实，带有颜色区分的量表 | | **替代版 README** | 完整、诚实的重写版，包含 8 个必备章节 | | **成绩单** | 按类别评分：流行词、功能、安装说明、徽章、卡车因子 | | **最离谱的谎言** | 指出并公开处刑宣称与实际之间最大的落差 | | **一句话总结** | 少于 280 个字符，专为 Twitter 截图优化 | | **诚实认证徽章** | 可嵌入到真实 README 中的 shields.io 徽章 | | **ASCII 诚实度卡片** | 一张精美、适合分享的终端截图卡片 | | **快速改进建议** | 1-3 个作者现在就能执行的具体、可操作的修复方案 | ## 演示

## 输出示例 ``` ┌────────────────────────────────────────────────────┐ │ 🕵️ NOIR DETECTIVE — CASE FILE │ │ Subject: some-project/README.md │ └────────────────────────────────────────────────────┘ HONESTY SCORE: 51/100 🟡 "The README said 'no configuration required.' I've been doing this job long enough to know that's never true." REPORT CARD: Buzzword Restraint .... D+ (14 buzzwords in 200 words) Feature Honesty ....... C- (claims 8 features, 5 exist) Installation Accuracy . F (npm install does not work without Docker) Badge Discipline ...... B+ (3 badges, all links work) Bus Factor ............ D (one maintainer, bus waiting outside) GPA: 1.4 — Needs Intervention 🎯 "No configuration required" — said the tool that requires you to learn Webpack anyway, just six months later and under significantly more pressure. 🛡️ []() Quick Wins: → Add "requires Docker" to install section (30 seconds) → Remove "blazing fast" until benchmarks exist → Pick a license. Any license. Literally any license at all. ``` ## 它实际上审计了什么 吐槽虽然搞笑，但审计是认真的。以下是它检查的内容： | 检查项 | 它能发现什么 | |-------|--------------| | **流行词密度** | 精确统计 "modern"、"blazing fast"、"scalable" 等词汇的数量 | | **功能夸大** | 宣称的功能与实际实现的功能对比 | | **安装说明真实性** | 你的安装说明真的能跑通吗？ | | **徽章膨胀** | 徽章数量 ÷ 文档行数 = 膨胀率 | | **“极简”谎言** | 声称“minimal”，却有 847 个依赖 | | **缺失关键信息** | 没有 license。没有“这个项目不能做什么”。没有替代方案。 | | **卡车因子 (Bus Factor)** | 需要有多少人被公交车撞了，这个项目才会死掉 | | **演示腐烂** | 还在用 v0.1 的截图。但 UI 早就改过 4 次了。 | | **贡献表演** | CONTRIBUTING.md 存在。但外部贡献者提交并合并的 PR 为零。 | | **空头支票** | “生产就绪”。实际使用者：作者和一个朋友。 | ## 参数标志 ``` /readme-roast --ramsay # Gordon Ramsay /readme-roast --attenborough # David Attenborough /readme-roast --detective # Noir Detective /readme-roast --ex # The Ex (toxic, petty) /readme-roast --toddler # The Toddler (why? why?) /readme-roast --comedian # Stand-Up Comedian /readme-roast --brutalist # The Brutalist (5 words) /readme-roast --hypebeast # The Hypebeast (Gen Z) /readme-roast --self # Roast this skill itself /readme-roast --full # Full honest README rewrite /readme-roast --badge-only # Badge markdown only (CI) /readme-roast --json # JSON output (CI/CD) /readme-roast --help # All flags ``` ## 安装说明 ### 前置条件 - **[Claude Code](https://claude.ai/code)** — CLI 或 IDE 扩展。这是一个 Claude Code 技能。它需要 Claude Code。这是它唯一的依赖。 - 就这些。不需要 npm。不需要 Docker。不需要 14 个未公开的步骤。 ### 设置 ``` # Clone 到你的 Claude Code skills 目录 git clone https://github.com/KorroAi/readme-roast.git ~/.claude/skills/readme-roast # 或者直接复制文件 cp -r path/to/readme-roast ~/.claude/skills/readme-roast/ ``` 该技能会自动注册。你会立即看到 `/readme-roast` 处于可用状态。 ## 这个技能不能做什么 这个技能坦诚面对自己的局限性： - **它不能执行你的代码。** 它能指出你的 benchmark 文件是空的，但它不能运行 benchmark。 - **它无法深入验证远程仓库。** 当吐槽一个 URL 时，它只能看到 star 数量、issue 和 README 文本——看不到实际代码。现实情况可能更糟。 - **它不能替代人类审查者。** 它负责统计流行词并检查文件是否存在。而人类审查者能嗅到恐惧。 - **它不是一个 linter。** 它审计的是 README，而不是代码质量。你那 800 行的函数目前是安全的。暂时安全。 ## 为什么它有效 README-ROAST 不仅仅是一个笑话生成器。它确实很有用。 - **它能发现真实问题** — 缺失的 license、有问题的安装说明、过时的演示 - **它强迫你保持诚实** — 生成的替代版 README 往往比原版更好 - **它具有自嘲精神** — 开源界最好的幽默就是开自己的玩笑 - **徽章能自然传播** — 每一个“诚实认证徽章”都是一次推荐 - **8 种人设 = 无限重玩价值** — 你会为了看 Attenborough 怎么吐槽你的依赖而回来的 - **自我吐槽证明它不是伪君子** — `/readme-roast --self` 是展现可信度的终极操作 ## 吐槽大师的誓言 ## License MIT © [KorroAi](https://github.com/KorroAi)

💬 加入 KORROCORP 的 Discord — GitHub · X

标签：AI辅助, Claude Code, LNA, SOC Prime, 动态分析, 开发工具, 开发者体验, 文档生成, 防御加固