[깃허브] README 파일 잘쓰기

README 란?

 

깃허브의 README 파일은 프로젝트에 대한 설명과 사용 방법을 기술하는 중요한 문서이다.

👉  README 파일을 통해 다른 사용자들에게 프로젝트를 소개하고 협력하거나 기여할 수 있는 방법을 제시할 수 있다.

👉  포인트는 최대한 간결하고 명확하게 작성

 

README 파일을 잘 쓰는 팁!

 

1. 목적과 개요

👉  프로젝트의 목적과 개요를 간략히 설명하며, 프로젝트의 주요 기능이나 이점을 간결하게 제시

 

2. 설치 방법

👉  필요한 의존성 패키지나 라이브러리를 어떻게 설치해야 하는지 명시

 

3. 사용 방법 

👉  사용자가 프로젝트를 어떻게 실행하고 사용해야 하는지 설명 ; 명령어 예시나 실행 단계를 제공하는 방법 등이 있음

 

4. 기여 방법

👉  만약 오픈 소스 프로젝트라면, 기여하는 방법을 명시하는 것이 좋음 ; 이슈를 제출하는 방법이나 코드를 제출하는 방법 등을 포함

 

5. 라이선스 정보 

👉  다른 사용자들이 프로젝트를 사용할 때, 어떤 규칙으로 사용해야 하는지 알려줌

 

6. 빌드 상태나 배지

👉  프로젝트의 빌드 상태나 테스트 커버리지를 보여주는 배지를 추가 ; 프로젝트의 현재 상태를 시각적으로 보여줄 수 있음

 

7. 예시와 스크린샷

👉  프로젝트를 사용하는 예시나 스크린샷을 제공하여 사용자들이 더 쉽게 이해하고 시도할 수 있게 도움

 

8. 문제 해결 방법

👉  자주 발생하는 문제들과 그 해결 방법을 문서에 포함

 

9. 연락처 정보 

👉  프로젝트를 사용하는 사용자들이 질문이나 제안을 할 수 있도록 연락처 정보나 이슈를 제출할 수 있는 링크를 제공

 

10. 업데이트 로그

👉  프로젝트의 버전 업데이트 내역과 변경사항을 기록 ; 사용자들이 최신 버전을 확인하고 업그레이드하는 데 도움

 

---

잘 작성한 README 예시

 

[사진 출처]

https://github.com/RichardLitt/standard-readme/blob/main/spec.md#specification

[추가 참고 링크]

https://github.com/matiassingers/awesome-readme