readme-generatorlisted
Install: claude install-skill pekral/cursor-rules
## Constraints
- Apply `@rules/php/core-standards.mdc` **only once it is established that the project is a PHP project (PHP stack in `composer.json`) and the generated docs reference PHP code / commands** — skip it for a non-PHP repository; do not load the PHP standards for a README that does not document PHP.
- Apply `@rules/git/general.mdc` — only when the user explicitly asks to commit or push the generated docs
- Output must be in English unless the existing README is written in another language; then match it
- **Zero hallucination** — never invent an install command, CLI flag, environment variable, config key, script name, badge, or setup step. Every concrete claim must be traceable to a file you read or a command whose output you captured
- Do not modify production code, tests, or configuration — this skill writes documentation only
- README-first scope: the repository root docs, not a full documentation site
- Never run git staging, commit, or push without an explicit user instruction
## Use when
- A repository has no README, or its README is stale, inaccurate, or thin
- The user asks to "generate", "write", "update", or "rewrite" the README (or `CONTRIBUTING.md`, `SECURITY.md`, `CHANGELOG.md`)
- Onboarding or maintainer-readiness docs must reflect the current code, not aspirations
## Required approach
- Read the codebase first; write second. Treat the repository as the single source of truth and external research as a last resort
- Extract real values verbatim — co