AIHub Korea
← 프롬프트 목록
개발모든 AI

README 문서 자동 생성

프로젝트 기본 정보를 입력하면 GitHub에 올릴 수 있는 전문적인 README.md를 자동 생성합니다.

공유:X
프롬프트 전문
당신은 오픈소스 프로젝트 관리 전문가입니다. GitHub에서 별점을 받을 수 있는 매력적인 README를 작성합니다.

[프로젝트 정보]
- 프로젝트명: {이름}
- 한 줄 설명: {이 프로젝트가 무엇인지 1문장}
- 주요 기능: {핵심 기능 3~5가지}
- 기술 스택: {사용한 언어/프레임워크/라이브러리}
- 라이선스: {MIT / Apache 2.0 / GPL 등}
- 데모 URL: {있다면}
- 설치 방법: {npm install / docker / 기타}
- 언어: {한국어 / 영어 / 이중 언어}

전문적인 README.md를 작성하세요:

```markdown
# {프로젝트명}

{뱃지 영역}
![License](https://img.shields.io/badge/license-{라이선스}-blue)
![Version](https://img.shields.io/badge/version-{버전}-green)

> {프로젝트 한 줄 설명 — 임팩트 있게}

{프로젝트 스크린샷 또는 GIF 자리}

## ✨ 주요 기능

- **{기능 1}** — {설명}
- **{기능 2}** — {설명}
- **{기능 3}** — {설명}
- **{기능 4}** — {설명}

## 🚀 빠른 시작 (Quick Start)

### 요구사항
- {필수 소프트웨어와 버전}

### 설치
\`\`\`bash
# 저장소 클론
git clone https://github.com/{user}/{repo}.git
cd {repo}

# 의존성 설치
{설치 커맨드}

# 환경 변수 설정
cp .env.example .env

# 실행
{실행 커맨드}
\`\`\`

## 📖 사용법

### 기본 사용
\`\`\`{언어}
{기본 사용 코드 예시}
\`\`\`

### 고급 설정
\`\`\`{언어}
{설정 예시}
\`\`\`

## 🏗 프로젝트 구조
\`\`\`
{디렉토리 구조}
\`\`\`

## 🔧 환경 변수
| 변수명 | 설명 | 필수 | 기본값 |
|--------|------|------|--------|

## 🤝 기여하기 (Contributing)
기여를 환영합니다! [CONTRIBUTING.md](CONTRIBUTING.md)를 참고해주세요.

1. Fork
2. Feature branch (`git checkout -b feature/amazing`)
3. Commit (`git commit -m 'Add amazing feature'`)
4. Push (`git push origin feature/amazing`)
5. Pull Request

## 📝 라이선스
{라이선스} License — [LICENSE](LICENSE) 파일 참고

## 📮 연락처
- {이름} — {이메일}
- 프로젝트 링크: {URL}
```

사용 방법

  1. 1위 "프롬프트 복사" 버튼을 클릭하세요.
  2. 2Claude 또는 ChatGPT 채팅창에 붙여넣기 하세요.
  3. 3중괄호 {변수} 부분을 실제 내용으로 교체하세요.
#README#문서#GitHub#오픈소스