README.md 작성법

README란?

GitHub에서 Repository를 보게되면, 하단에 README.md 라는 제목 밑에 써진 글을 볼 수 있다.

해당하는 Repository의 지침서이며, Markdown 확장자를 사용하는 문서이다.

나, 동료, 사용자를 위해 필요한 설명서라고 할 수 있다.

 

작성법이 따로 있는 것은 아니지만

프로젝트에 대해서 나중에 봐도 알 수 있게, 남이 봐도 알 수 있게 설명을 잘 쓰는 것은 중요하다.

 

Markdown 문법

작성 방법 (주관적 의견)

작성법은 따로 정해져 있지 않다. 필자는 README에 밑의 내용이 포함되면 좋다고 생각한다.

• 프로젝트 요약
• 실행 방법
• 주의사항

프로젝트 요약

프로젝트에 대한 설명을 간단히 포함시킨다.

실행 방법 & 주의사항

설치해야하는 패키지를 설치법과 함께 표시한다.

특정 운영체제, 브라우저에서만 실행되는지 명시한다.

실행시키는 방법에 대해서도 적는다.

 

 

프로젝트의 규모가 커진다면 기여 방법, 라이센스, 버그, FAQ 등을 포함시켜도 좋을 것 같다.