readme-skeleton

作者：AgentsRoomAgentsRoom 已验证尚无安装尚无点赞更新于 2026年5月7日分类：工程

它能做什么

Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.

安装会在你的 AgentsRoom 桌面端打开这个条目。如果还没有安装应用，你会被带到下载页面。

SKILL.md

---
name: readme-skeleton
description: Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.
---

# README skeleton

When asked to add or rewrite a README, produce these sections in this order:

1. **One-liner** — what does this thing do, in 12 words max.
2. **Quick start** — exact commands to clone + install + run + see it working.
3. **Configuration** — required env vars, with examples and what happens when missing.
4. **Project structure** — only if non-obvious; one paragraph max.
5. **Contributing** — branch convention, test command, PR review expectation.

Skip: marketing fluff, badges nobody clicks, screenshots that go stale, history.

标签

docs