create-readme
Create a README.md file for the project
Works with
--- name: create-readme description: Create a README.md file for the project license: MIT --- # README Creation Create a comprehensive and well-structured README.md file for your project that serves as the primary entry point for users, developers, and contributors. ## Key Elements - Clear project title and description - Technology stack overview - Quick start / getting started section - Installation instructions - Usage examples - Project structure overview - Development workflow - Contributing guidelines - License information - Links to detailed documentation ## Best Practices - Use clear, concise language - Include code examples where helpful - Provide quick wins for new users - Reference detailed documentation in other files - Maintain consistency with project style - Use proper Markdown formatting - Include badges for build status, version, etc. - Optimize for scanning (use headings effectively) ## When to Use - Creating a new project README - Refreshing documentation for better clarity - Adding comprehensive developer information - Standardizing README structure
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.
