gtskevin/readme-craft

readme-craft은(는) 무엇을 하나요?

🚀 Codex/Claude Code 스킬: 모든 GitHub 저장소를 전문적이고 별이 가득한 쇼케이스로 변환하세요. README, SVG 에셋, 배지 및 커뮤니티 파일을 자동 생성합니다.

개요

README Craft는 AI 에이전트(예: Claude Code, Codex)가 GitHub 저장소를 분석하고, 그 결과를 바탕으로 저장소의 매력을 극대화하는 마크다운 및 에셋 파일을 생성할 수 있도록 설계된 강력한 스킬입니다. 저장소의 README를 처음부터 작성하거나 기존 README를 개선하는 데 사용할 수 있습니다.

주요 기능

• README 자동 생성: 저장소의 코드, 종속성, 구조 및 메타데이터를 분석하여 포괄적이고 잘 구성된 README 파일을 생성합니다.
• SVG 에셋 생성: 저장소의 브랜딩 및 설명에 맞춘 맞춤형 SVG 이미지(예: 로고, 배너, 다이어그램)를 생성합니다.
• 배지 자동화: 기술 스택, 빌드 상태, 테스트 커버리지 등을 나타내는 인기 있는 배지를 자동으로 생성합니다.
• 커뮤니티 파일 생성: 기여 가이드라인, 행동 강령, 이슈/PR 템플릿과 같은 필수 커뮤니티 파일을 생성합니다.
• 마크다운 품질 보장: 생성된 README가 GitHub 마크다운 모범 사례를 준수하고, 가독성이 뛰어나며, 검색 엔진에 최적화되도록 보장합니다.

지원 플랫폼

• Claude Code (Anthropic)
• Codex (OpenAI)
• 기타 AI 에이전트 도구

사용 방법

1. 저장소의 루트 디렉토리에서 AI 에이전트를 실행합니다.
2. 다음 명령어를 사용하여 README 생성을 요청합니다:

   readme-craft
   

3. AI가 저장소를 분석하고 생성된 파일을 표시합니다.
4. 생성된 파일을 검토하고 원하는 대로 수정합니다.
5. 변경 사항을 저장소에 커밋합니다.

사용 예시

# Claude Code에서
claude "readme-craft를 사용하여 내 저장소 README를 생성해줘"

# Codex에서
codex "readme-craft를 실행하여 README 및 에셋 생성"

생성되는 파일

파일	설명
README.md	저장소의 메인 README 파일
assets/logo.svg	저장소 로고 (SVG 형식)
assets/banner.svg	저장소 배너 이미지
assets/badges.svg	기술 배지 모음
CONTRIBUTING.md	기여 가이드라인
CODE_OF_CONDUCT.md	행동 강령
.github/ISSUE_TEMPLATE/	이슈 템플릿
.github/PULL_REQUEST_TEMPLATE.md	PR 템플릿

구성

스킬은 환경 변수 또는 구성 파일을 통해 추가로 사용자 지정할 수 있습니다.

변수	설명	기본값
README_CRAFT_STYLE	README 스타일 (professional, creative, minimal)	professional
README_CRAFT_INCLUDE_BADGES	배지 포함 여부	true
README_CRAFT_INCLUDE_SVG	SVG 에셋 생성 여부	true
README_CRAFT_LICENSE	README에 포함할 라이선스 유형	저장소에서 감지

모범 사례

• AI가 README를 생성한 후 항상 검토하고 편집하세요.
• 저장소에 맞게 생성된 SVG 에셋을 사용자 정의하세요.
• 커뮤니티 파일을 업데이트하여 저장소의 규칙을 반영하세요.
• 생성된 README에 관련 링크(예: 문서, 웹사이트)를 추가하세요.

문제 해결

문제: README 생성이 실패합니다. 해결책: 저장소에 package.json, requirements.txt, Cargo.toml 등 인식 가능한 프로젝트 파일이 있는지 확인하세요.

문제: SVG 이미지가 깨져 보입니다. 해결책: SVG 파일의 XML 구문이 올바른지 확인하고, 필요한 경우 수동으로 수정하세요.

문제: 배지가 올바르게 표시되지 않습니다. 해결책: 배지 URL이 유효한지 확인하고, shields.io와 같은 배지 서비스가 접근 가능한지 확인하세요.

라이선스

이 스킬은 MIT 라이선스에 따라 제공됩니다. 자세한 내용은 LICENSE 파일을 참조하세요.