Readme 파일은 주로 Github 혹은 Repository에 대한 설명을 나타내기 위해 작성합니다. 가이드라인, 혹은 제품 사용설명서라고 생각하면 편함.
-
for my self 내가 코딩한 프로그램이라고 해서 언제까지나 코드의 모든 내용을 이해하고 있을 수는 없죠?
시간이 흘러 자신의 프로그램을 다시 읽어보고 해석해야 할 일이 생길 경우, Readme 파일이 필요한 수고를 덜어줍니다. -
for my co-workers 함께 협업하는 동료들에게 지침서 역할로 유용하게 쓰일 수 있습니다.
-
for users 서비스를 구현하여 오픈소스로 배포하는 경우, 자신의 프로그램을 이용하는 사람들이 쉽게 이해할 수 있게 하구요.
프로젝트 구성
프로젝트 프로그램 설치방법
프로젝트 프로그램 사용법
저작권 및 사용권 정보
프로그래머 정보
버그 및 디버그
참고 및 출처
버전 및 업데이트 정보
FAQ
너무 딱딱한 형식이 싫다면 프로젝트 소개, 개발 기간, 개발자 소개(역할분담 상세), 개발환경, 기술스택, 주요기능, 프로젝트 아키텍쳐 등을 포함하여 작성하는 방법도 있어요.
확장자 역시 정해져 있지 않으나, 일반적으로 .md(markdown) 확장자를 사용할 것을 권장합니다.