generate-readme
Create a README.md for a project
Works with
--- name: generate-readme description: Create a README.md for a project license: MIT --- # 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`.
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
