Generate README

Purpose

Create a README.md for a project

Routing

• Use when: Use when user asks to generate or refresh project documentation.

• Do not use when: Don't use for API docs generated by package tooling.

• Outputs: A full README draft with sections usable for onboarding.

• Success criteria: Covers setup, usage, and contribution in one coherent document.

Trigger Examples

Positive

• Use the generate-readme skill for this request.

• Help me with generate readme.

• Use when user asks to generate or refresh project documentation.

• Generate README: provide an actionable result.

Negative

• Don't use for API docs generated by package tooling.

• Do not use generate-readme for unrelated requests.

• This request is outside generate readme scope.

• This is conceptual discussion only; no tool workflow is needed.

Runtime Prompt

• Current runtime prompt length: 558 characters.

• Runtime prompt is defined directly in ../generate-readme.json .