yinuo-136 README Generator
Generate a professional, well-structured README.md for any project.
Demo Purpose: This skill demonstrates the
assets/directory — Agent reads the template file fromassets/and fills it with project-specific information.
When to Use
- User asks to "create a README" or "generate project docs"
- A new project has no README.md
- User wants to improve an existing README
Instructions
- Analyze the project: read key files (
package.json,pyproject.toml, main source files, etc.) - Identify: project name, description, tech stack, setup steps, project structure
- Fill in the template from assets/TEMPLATE.md
- Adapt sections — remove irrelevant ones, add project-specific ones
Process
Step 1: Gather Project Info
Look for these files to extract information:
| File | What to Extract |
|---|---|
package.json |
Name, description, scripts, dependencies |
pyproject.toml |
Name, version, dependencies |
go.mod |
Module name, Go version |
Cargo.toml |
Name, version, dependencies |
Dockerfile |
Runtime environment |
.env.example |
Required environment variables |
Step 2: Apply Template
Read the template from assets/TEMPLATE.md and fill in each section with the gathered information.
Step 3: Customize
- Remove sections that don't apply (e.g., no "API" section for a CLI tool)
- Add project-specific sections if needed
- Ensure all placeholder text
[...]is replaced with real content
Example
For a Python FastAPI project, the generated README might start with:
# My API
A RESTful API for managing user accounts and authentication.
## Tech Stack
- **Runtime**: Python 3.12
- **Framework**: FastAPI 0.110
- **Database**: PostgreSQL + SQLAlchemy
- **Testing**: pytest
## Quick Start
git clone https://github.com/user/my-api.git
cd my-api
pip install -e ".[dev]"
uvicorn src.main:app --reload