GitHub README 생성기

GitHub README 생성기 사용 가이드

새 저장소를 만들면 README부터 써야 하지만 빈 화면에서 시작하기는 막막합니다. 이 생성기는 프로젝트 이름과 주소, 그리고 생각나는 대로 적은 몇 줄을 받아 GitHub에서 흔히 쓰는 구성의 README 초안을 만들어 줍니다.

'세부 내용'의 첫 줄은 한 줄 소개가 되고, 나머지 일반 줄은 주요 기능 목록이 됩니다. npm, pip, git, docker 같은 명령으로 시작하는 줄은 명령어로 알아보고, install·clone이 든 명령은 '설치', 나머지는 '사용법' 코드 블록에 넣습니다. 'license: MIT'처럼 적으면 라이선스 절에 들어갑니다.

비어 있는 절에는 '<!-- 설치 명령을 적으세요 -->' 같은 안내 주석이 남아 무엇을 채워야 할지 보입니다. 한국어 페이지에서는 절 제목도 한국어로 만듭니다.

사용 방법

1. 1'프로젝트 이름'과 '저장소·홈페이지 주소'를 적습니다.
2. 2'한 줄 소개, 기능, 설치·실행 명령 (한 줄에 하나)' 칸에 소개 문장, '- 기능', 명령어, 'license: MIT'를 한 줄씩 적습니다.
3. 3'실행'을 누른 뒤 결과를 '다운로드'해 저장소의 README.md로 저장하고 안내 주석이 남은 곳을 채웁니다.

프로젝트 이름: ToolBada
저장소·홈페이지 주소: https://toolbada.com
세부 내용:
브라우저에서 바로 쓰는 무료 도구 모음
- 설치 없이 실행
- 파일을 서버로 보내지 않음
npm install
npm run build
license: MIT

# ToolBada

브라우저에서 바로 쓰는 무료 도구 모음

- 링크: https://toolbada.com

## 주요 기능

- 설치 없이 실행
- 파일을 서버로 보내지 않음

## 설치

```bash
npm install
```

## 사용법

```bash
npm run build
```

## 라이선스

MIT

이럴 때 쓰면 좋아요

• 새 오픈소스 저장소의 README 뼈대를 빠르게 만들 때
• 사내 프로젝트 README의 절 구성을 통일할 때
• README가 없는 오래된 저장소에 기본 문서를 붙일 때
• 해커톤 결과물의 소개 문서를 몇 분 안에 정리할 때

문제가 생겼을 때

활용 팁

• README 맨 위 배지(빌드 상태, 버전)는 README 배지 정리기로 정돈한 뒤 제목 아래에 붙이면 좋습니다.
• 초안을 채운 뒤 GitHub README 품질 검사기로 설치·사용법·라이선스 절이 빠지지 않았는지 확인하세요.

자주 묻는 질문