Read Me Launcher
핵심 약속: 리포지토리에 정확히 일치하는 README
먼저 검사하십시오. 스택에 대한 사실을 절대 지어내지 마십시오. 대상 독자를 위해 최소한의 정직한 증거를 선택하십시오. 마치기 전에 렌더링 오류와 시크릿 문자열을 린트하십시오.
0단계: 분류
scripts/inspect-repo.sh를 실행합니다.- INTERFACE × AUDIENCE × PRIMARY_PROOF 를 결정합니다 (references/taxonomy.md 참조).
- 필요시 모드 약칭에 매핑합니다 (references/audience.md 참조).
엄격한 규칙 (오류)
- 설치/실행/테스트에 대한 주장이 검사 결과와 일치함 (✓ 확인됨 vs ? 알 수 없음)
- 발명된 기능, 스크립트 또는 런타임이 없음
-
<div>/<section>/<center>내부에 코드 펜스가 없음 - README에서 참조하는 로컬 이미지가 존재함
-
scripts/check-readme.sh README.md가 0으로 종료됨 (시크릿 + 렌더링 검사) - references/privacy.md의 개인정보 보호 규칙을 준수함
강력한 기본값 (보편적 지침은 아님)
- 라이브러리는 마케팅 벽화가 아닌 작동하는 코드로 시작함
- 내부 리포지토리는 런북(runbook)에 최적화되며, 출시를 위한 극장용이 아님
- 공개 GUI는 일반적으로 하나의 실제 스크린샷이 필요함
- 각 에셋이 무언가를 증명할 때만 배너/미리보기/쇼케이스를 추가함
- 래스터 히어로 이미지를 포함할 때는 PNG 선호 (references/visuals.md 참조)
스타일 선호사항 (경고 / 선호)
- 줄표(em dash) 사용은 선호사항(
PREF)임; 사용자가 엄격한 실패를 원하는 경우에만--strict-style사용 - 기본적으로 접힌 부분 위에는 최대 ~3개의 배지만 표시
- 이모지 스팸과 배지 벽을 피함
워크플로우
- 검사 -
scripts/inspect-repo.sh - 분류 - 분류 체계 + 대상 독자
- 증거 선택 - 필요한 최소 증거
- README 초안 작성 - references/design.md, references/section-map.md 참조
- 필요한 경우에만 에셋 생성 - references/generation.md 참조
- 린트 -
scripts/check-readme.sh README.md - 소비자 관점 검토 - 낯선 사람이 첫 화면만 보고 설치할 수 있겠는가?
주장 표시자 (초안/검토 시 권장)
| 표시자 | 의미 |
|---|---|
| ✓ 확인됨 | 검사/매니페스트에서 확인됨 |
| ~ 유추됨 | 합리적이나 리포지토리에 명시적이지 않음 |
| ? 알 수 없음 | 사실로 제시하지 말 것 |
| ✗ 지원되지 않음 | 제거하거나 다시 작성할 것 |
출력 규칙
- README를 작성 (에셋은 정당한 경우에만)
- 기존의 좋은 README를 파괴적으로 다시 작성하는 것보다 수정 선호
- "AI 생성" 문구 금지
check-readme.sh가 검사하는 범위 이상으로 "시크릿 안전"을 과장하지 말 것; 잔여 위험을 명시
번들 리소스
| 경로 | 사용 시점 |
|---|---|
| scripts/inspect-repo.sh | 항상 먼저 |
| scripts/check-readme.sh | 항상 마치기 전 |
| references/taxonomy.md | 분류 |
| references/audience.md | 증거 모드 |
| references/visuals.md | 이미지 형식 |
| references/generation.md | 에셋 프롬프트 / 금지사항 |
| references/design.md | 구조 |
| references/privacy.md | 공개/비공개 + 거부 목록 |
| references/section-map.md | 유형별 섹션 |
| tests/run-tests.sh | 로컬 검증 |