👍 좋은 README는 어떻게 만들까?
How to write a great README
Shields.io: Quality metadata badges for open source projects
✏️ 좋은 README 작성하기 ✏️
1. README 상단부분에 넣어야할것들
-
로고
-
배지
-
주요 링크
-
소프트웨어 특징을 나타내는 이미지 텍스트
2. 캐치프레이즈(Catchphrase)/주요 기능(Features)
- 주요 기능 = 사용자들이 알고 싶은 정보
- 캐치프라이즈 = 주요 특징을 한문장으로 요약한것