跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
演示文稿

readme-creator

Creates or rewrites a README for the project consumer, using verified install commands, a runnable quickstart, and house presentation conventions. Use when asked to "write a README", "rewrite our README", or replace scaffold boilerplate. For an in-place prose audit use docs-writing; for agent instructions use agents-md.

mblode · 已有 AI 审核记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add mblode/agent-skills --skill readme-creator

技能说明


name: readme-creator description: Creates or rewrites a README for the project consumer, using verified install commands, a runnable quickstart, and house presentation conventions. Use when asked to "write a README", "rewrite our README", or replace scaffold boilerplate. For an in-place prose audit use docs-writing; for agent instructions use agents-md.

README Creator

Write a README that reads as a shop window, not a wiki.

  • IS: writing or rewriting README.md for the person deciding whether to use the project, with the project type driving which capability sections earn a place and where the file will render (GitHub only, or also a registry page) driving image and badge choices.
  • IS NOT: polishing the prose of a README that already covers the project, or a multi-page docs site (use docs-writing); AGENTS.md or CLAUDE.md agent-instruction files (use agents-md); fixing the install or first-run experience the README describes (use dx-audit); marketing copy for a landing page (use copywriting).

The reader

Someone arrived from a search result, a registry listing, or a profile page. They have about fifteen seconds and one question: is this worth my time? Every line either answers that or gets cut.

They are not a contributor. Nothing about the build pipeline, the workspace layout, the release process, or the coding standards helps them decide, so none of it belongs here.

This deliberately departs from standard-readme and Make a README, which require ## Contributing, add a table of contents past 100 lines, and hold that too long beats too short. Do not drift back to those defaults: contributor content moves to CONTRIBUTING.md or AGENTS.md, and length follows what the reader needs.

Reference Files

FileRead when
references/section-templates.mdPhase 3: markup for each spine section, the capability-section menu, and per-type notes
references/badges-and-shields.mdPhase 4: only once Phase 1 has found a registry listing (npm, crates.io, PyPI, VS Code Marketplace, skills.sh)
references/quality-checklist.mdPhase 5: score before declaring done

Voice

Check for a profile from the external ghostwriter skill before drafting: ${GHOSTWRITER_HOME:-~/.config/ghostwriter}/readme.md. When one exists it owns the register, the spelling convention, and any house-style markup (header block, badge colours, footer credit), and it wins every conflict with this skill. Follow it; do not restate it here.

With no profile, default to terse second-person imperative, no emoji, no exclamation marks, and concrete numbers over adjectives.

Workflow

Copy this checklist to track progress:

README progress:
- [ ] Phase 1: Detect project type and where the README renders
- [ ] Phase 2: Fix the spine, then choose capability sections
- [ ] Phase 3: Write each section from the template
- [ ] Phase 4: Add badges (registry-listed projects only)
- [ ] Phase 5: Score against the checklist; report the pass count and render-check output

Phase 1: Detect project type and render targets

Read the manifest (package.json, Cargo.toml, pyproject.toml, go.mod) for name, description, license, scripts, bin, "private", and repository. Read the existing README if rewriting. Scan the top-level layout.

Classify into exactly one type. First matching row wins, top to bottom:

TypeDecisive signal
Skill bundleskills/ dir of SKILL.md files
Monorepoworkspace config (turbo.json, pnpm-workspace.yaml, workspaces)
CLI toolbin field, src/cli.*, or commander/yargs/clap dep
Frameworkplugin/middleware architecture, config API, documented extension points
Library / packagemain/exports set, no bin, src/index.* entry
Web appframework config (next.config.*, vite.config.*); no publish

A monorepo is not a project type for README purposes. It is a delivery mechanism. Ask what a stranger installs or visits, then write the README for that: a repo whose apps/cli publishes to npm gets a CLI README at the root, not a workspaces table. The workspace layout goes in AGENTS.md.

If two types still fit (a CLI that also exports an API, a framework published as a library), pick how most users consume it and fold the secondary role into one extra section.

Then record where the file renders. A "private": true manifest or no registry listing means GitHub only. A published package also renders on npmjs.com, PyPI, or crates.io, which changes image URLs and earns badges (Phase 4 and the Gotchas).

Ask the user only what code cannot reveal:

  • What problem does this solve (the "why" behind the tagline)?
  • Any section to force in or leave out?

If unreachable, infer the "why" from the manifest and code, note the assumption in your summary, and proceed rather than block.

Phase 2: Fix the spine, then choose capability sections

Use this house spine where applicable. A hosted app can lead with its live URL instead of an install command; do not invent installation for a product consumed in the browser:

  1. Header block (title, tagline, plain second line, badges if registry-listed)
  2. ## Demo (only when a live URL exists)
  3. ## Install
  4. ## Quickstart
  5. ## License

Between Quickstart and License go the capability sections: two to four, chosen from the menu in references/section-templates.md. Four is a ceiling because a fifth section is almost always contributor content wearing a reader-facing heading; when a fifth genuinely serves the reader, say why in your summary rather than silently adding it.

Canonical heading names keep a set of repos consistent: Install, Quickstart, Demo, License. Not Installation, Getting Started, Quick start, Quick Start, Licence. Sentence case throughout, so ## Browser support and not ## Browser Support.

The audience gate. Before writing any section, ask wh

阅读完整来源 ↗