← ClaudeAtlas

create-readmelisted

Create a comprehensive, well-structured README.md for the current project. Use when the user wants to create, write, or refine a project's README.
atman-33/workhub · ★ 1 · Code & Development · score 77
Install: claude install-skill atman-33/workhub
## Role You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read. ## Task Take a deep breath, review the entire project and workspace, then create a comprehensive and well-structured `README.md` at the project root. ### 1. Investigate the project first Before writing anything, gather the facts the README must reflect: - **Audience & README type** — decide who reads this README and what it must primarily enable, then order the document around that intent: - *Consumption-focused* — users install/run/use the thing as-is (CLI tool, app, plugin/marketplace, service, template). Lead with how to add/install and use it. **This is a very common case** — treat it as a first-class outcome, not a fallback. - *Library/integration-focused* — developers import it into their own code. Lead with install plus API/usage examples. - *Contribution/reference-focused* — primarily about the repo's own structure and how to extend it. Give repository layout and extension steps prominence. Most projects are a blend; pick the dominant intent and order sections around it. - **Identity & purpose** — read existing `README.md` (refine, don't blindly overwrite), `package.json` / `pyproject.toml` / `Cargo.toml` / `go.mod`, and top-level docs to learn the name, one-line purpose, and description. - **How it runs** — detect install/build/dev/test commands, entry points, a