---
name: cowork-os-generate-readme
description: "Create a README.md for a project"
license: "MIT"
metadata:
  decimalai-skill-id: "b656f102-757f-40bc-9ef1-c2d1a1ed52bb"
  decimalai-version-id: "420f1b90-ba73-444d-8026-28b316541b24"
  decimalai-version: "1"
  decimalai-body-sha256: "20eaf59443b0d1a84882b2eef49d9f31464cddd0c577de557dfbfd7c8576782d"
  decimalai-name: "cowork-os/generate-readme"
  decimalai-format: "1"
  decimalai-invocation: "model"
  decimalai-category: "documentation"
  decimalai-source: "https://app.decimal.ai/s/cowork-os-generate-readme@1/SKILL.md"
---
# 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`.