GitHub README 생성기
Copied!
Project Info
Title
Description
GitHub Repo
Author
License
Content Sections
Features
Installation
Usage
Options
오픈소스 개발자를 위한 인터랙티브 README.md 빌더입니다. 프로젝트 세부 정보(제목, 설명, 기능, 설치 단계, 사용 예)를 입력하면 GitHub 배지, 목차, 적절한 마크다운 구조가 포함된 전문적으로 포맷된 README를 얻을 수 있습니다. 수동 포맷이 필요 없습니다.
왜 이 README 빌더를 사용하나요?
- 전문적인 출력 — 매번 깔끔하고 구조화된 마크다운을 생성합니다.
- GitHub 배지 — Stars, Forks, Issues, License 실드를 자동 생성합니다.
- 목차 — 앵커 링크가 포함된 선택적 자동 생성 목차.
- 원클릭 복사 — 전체 README를 즉시 클립보드에 복사합니다.
주요 기능
- 배지: Shields.io를 통한 GitHub 스타, 포크, 이슈, 라이선스 배지.
- 섹션: 기능 목록, 설치 방법 (코드 블록), 사용법 (코드 블록), 라이선스, 작성자.
- 목차: 적절한 앵커 링크가 포함된 자동 생성 목차.
- 유연성: 작성된 섹션만 포함 — 비워두면 해당 섹션을 건너뜁니다.
작동 방식
이 생성기는 입력한 양식 데이터를 읽어 Markdown 문서를 위에서 아래로 구성합니다. 배지는 Shields.io URL과 GitHub 사용자명/저장소 정보를 사용하여 생성됩니다. 기능은 글머리 기호로, 설치 및 사용법은 코드 블록으로 감싸집니다. 목차는 GitHub의 앵커 형식을 사용하여 섹션 제목에 연결됩니다.
README 생성기 사용해 보기
위의 프로젝트 세부 정보를 입력하고, 배지와 목차를 켜거나 끈 다음 “README 생성”을 클릭하세요. 결과를 복사하여
README.md
파일에 직접 붙여넣으세요.