GitHub README 품질 검사기

GitHub README 품질 검사기 사용 가이드

좋은 README는 처음 온 사람이 '무엇인지, 어떻게 설치하고 쓰는지, 써도 되는지'를 바로 알 수 있게 해 줍니다. 이 검사기는 README가 이런 기본 요소를 갖췄는지 6가지 항목으로 점검합니다.

점검 항목은 # 제목(H1), 제목 아래 20자 이상의 소개 문단, 설치·시작 절(설치, Installation, Getting started 등), 사용법·예시 절(사용법, Usage, Example 등), ``` 코드 블록 예시, 라이선스 절입니다. 절은 제목 글자로 알아보며 한국어와 영어 표기를 모두 인식합니다.

결과 아래에는 '점수 5/6'과 함께 제목 수, 링크 수, 단어 수가 나옵니다. 내용의 정확성이나 문장 품질은 평가하지 않습니다.

사용 방법

1. 1'.md·.txt 파일'에서 README.md를 고르거나 'Markdown 내용'에 README를 붙여 넣습니다.
2. 2'실행'을 누르면 항목마다 '있음/없음'과 점수가 나옵니다.
3. 3'없음'으로 나온 항목의 절을 추가하고 다시 실행해 점수를 확인합니다.

# ToolBada
브라우저에서 바로 쓰는 무료 도구 모음입니다.
## 설치
```bash
npm install
```
## 사용법
[문서](https://a.com)

있음	제목(# H1)
있음	제목 아래 소개 문단
있음	설치·시작 절
있음	사용법·예시 절
있음	코드 블록 예시
없음	라이선스 절
점수 5/6 · 제목 3개 · 링크 1개 · 단어 12개

이럴 때 쓰면 좋아요

• 오픈소스로 공개하기 전에 README 기본 구성을 점검할 때
• 여러 사내 저장소의 README 수준을 비교할 때
• README 템플릿을 만든 뒤 빠진 절이 없는지 확인할 때
• 외부 기여를 받기 전 문서 준비 상태를 볼 때

문제가 생겼을 때

활용 팁

• 점수는 기본 구성 확인용입니다. 6/6이어도 설치 명령이 실제로 동작하는지는 새 환경에서 직접 따라 해 보세요.
• 빠진 절이 많으면 GitHub README 생성기로 뼈대를 만들고 기존 내용을 옮겨 넣는 편이 빠릅니다.

자주 묻는 질문