readme-audit

Name: readme-audit
Author: Archive228

712stars129forks

How to install readme-audit?

archive228/loopkit/readme-audit

$npx -y skills add Archive228/loopkit --skill readme-audit

Installs into the current project.

Summary

Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.

Files · 1

View on GitHub

SKILL.md

1	# README Audit
2	A README's only job: a stranger clones it and gets to "it works" without asking you.
3	Check, in order:
4	1. One sentence on what it is and who it's for — above the fold.
5	2. Install — copy-paste commands that actually work on a clean machine. Test them mentally step by step.
6	3. Run / quickstart — the smallest end-to-end example.
7	4. Config — required env vars, where secrets go.
8	5. No rot — does it reference files/commands/flags that still exist? Stale README is worse than none.
9	Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k

1	# README Audit
2	A README's only job: a stranger clones it and gets to "it works" without asking you.
3	Check, in order:
4	1. One sentence on what it is and who it's for — above the fold.
5	2. Install — copy-paste commands that actually work on a clean machine. Test them mentally step by step.
6	3. Run / quickstart — the smallest end-to-end example.
7	4. Config — required env vars, where secrets go.
8	5. No rot — does it reference files/commands/flags that still exist? Stale README is worse than none.
9	Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.

1	# README Audit
2	A README's only job: a stranger clones it and gets to "it works" without asking you.
3	Check, in order:
4	1. One sentence on what it is and who it's for — above the fold.
5	2. Install — copy-paste commands that actually work on a clean machine. Test them mentally step by step.
6	3. Run / quickstart — the smallest end-to-end example.
7	4. Config — required env vars, where secrets go.
8	5. No rot — does it reference files/commands/flags that still exist? Stale README is worse than none.
9	Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.