README 생성기

문서화입문

프로젝트의 코드, 설정 파일, 디렉토리 구조를 분석하여 설치 방법, 사용법, 기여 가이드를 포함한 완성된 README.md를 생성합니다.

트리거/readme

사용빈도프로젝트 시작 시

오픈소스에 첫 기여를 준비하는 개발자라면? /readme로 프로 수준의 README를 빠르게 완성

사이드 프로젝트를 공개할 때라면? 깔끔한 README로 첫인상을 좋게

README문서오픈소스온보딩

작동 흐름

/readme 실행 → 프로젝트 분석

↓

Phase 1: 4개 섹션 생성 병렬

overview-gen

프로젝트 개요

install-gen

설치 가이드

usage-gen

사용 예시

contrib-gen

기여 가이드

↓

마크다운 조합 + 뱃지 추가

↓

✓ 완성된 README.md

스킬 코드

# README Builder Skill
## Trigger: /readme

When invoked:

1. Analyze project:
 - Package name, description, license
 - Tech stack and dependencies
 - Available scripts (build, test, lint)
 - Project structure

2. Generate README.md:
---
# Project Name

[1-line description]

[badges: build, coverage, license, version]

## Features
- ✨ [feature 1]
- 🚀 [feature 2]

## Quick Start

\`\`\`bash
# Install
[install command]

# Run
[run command]
\`\`\`

## Usage
[code example with explanation]

## Project Structure
\`\`\`
src/
├── [dir] — [description]
└── [dir] — [description]
\`\`\`

## Contributing
[contribution guide]

## License
[detected license]
---

복사해서 CLAUDE.md에 붙여넣으면 바로 사용할 수 있습니다.