Individual skill
readme-generator
Generate comprehensive, user-friendly README.md files for code repositories. Use when creating documentation for new projects, updating existing READMEs, or improving project onboarding. Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview. Supports application projects, libraries, and research codebases.
skills/readme-generator/SKILL.md
Source commit 4f38503747e0617504bce5329283ef837d375c09
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 6, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 260
- Repository last updated
- Aug 21, 2026
- License
- Apache-2.0
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- claude-skills Repository topic
- metaprogramming Repository topic
- software-development Repository topic
- software-engineering Repository topic
- claude Repository topic
- claude-code Repository topic
- docs Derived category
- research Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytesSKILL.mdcore · 10,356 bytes
Read excerpt
# README Generator
## Overview
Analyze a code repository and generate a comprehensive, reproducible README.md that enables users to quickly understand, set up, and use the project with clear instructions and executable examples.
## Workflow
### 1. Analyze Repository Structure
Explore the repository to understand its organization and purpose:
**Key files to examine**:
- `package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod` - Project metadata