README 생성기 (GitHub용 README.md)

좋은 README는 프로젝트의 첫 화면입니다. 프로젝트가 무엇을 하는지, 어떻게 설치하고 쓰는지, 어떻게 기여하는지를 알려 주며 GitHub, npm, GitLab에서 사람들이 가장 먼저 보는 문서입니다. 이 생성기는 짧은 양식을 독자가 기대하는 섹션, 즉 배지, 설명, 기능, 설치, 사용법, 기술 스택, API, 기여 방법, 라이선스, 작성자를 갖춘 완성된 README.md로 만들어 주고, 렌더링된 HTML도 받을 수 있습니다.

사용 방법

1. 프로젝트 이름, 한 줄 설명, GitHub 저장소(owner/name)를 입력합니다.
2. 기능, 설치 명령, 사용 예시를 채웁니다. 비워 두면 해당 섹션은 빠집니다.
3. 라이선스와 배지, 스크린샷 자리 표시자, 기여 안내, 목차 같은 추가 항목을 고릅니다.
4. 마크다운을 저장소 루트의 README.md에 복사합니다.

계산식

# 이름 → 배지 → 설명 → About → Features → Built with → Installation → Usage → API → Contributing → License → Author

내용이 없는 섹션은 빠집니다. 코드는 코드 안의 백틱 연속보다 긴 울타리를 가진 코드 블록에 담기므로 아무것도 깨지지 않습니다. 배지는 shields.io를 쓰며, 정적 라이선스 배지("-"는 shields.io 규칙대로 "--"로 씀), npm 버전과 다운로드, GitHub 별, 이슈, 마지막 커밋이 있습니다. 목차 링크는 GitHub의 제목 앵커 규칙(소문자, 공백은 하이픈, 문장 부호 제거)을 따릅니다. HTML 버전은 marked 라이브러리의 GitHub 방식(GFM) 모드로 만듭니다.

예시

샘플은 awesome-cli의 README를 만듭니다. 라이선스 배지와 GitHub 배지 3개, 한 줄 설명, About 문단, 기능 3개, "Built with" 아래의 Node.js와 TypeScript, clone 명령과 이어지는 npm install -g awesome-cli, 사용법 블록, 기여 절차, MIT 라이선스 줄, 작성자까지 모두 8개 섹션입니다.