7.3.3 프로젝트 설명서 리드미(README) 작성하기

리드미(README)는 ‘Read Me(나를 읽어라)’를 대문자로 표기한 것으로, 소프트웨어 프로젝트나 코드 저장소(repository)의 가장 기본적이고 핵심적인 안내서입니다. README.md라는 마크다운(markdown) 파일 이름으로 보이며, 프로젝트와 관련된 모든 중요한 정보를 한눈에 파악할 수 있도록 정리해 놓은 문서입니다.

커서에 리드미를 작성해 달라고 요청합니다. 개발할 때 사용한 모델에 따라 리드미를 자동으로 작성하기도 하고 직접 요청해야 하기도 합니다. 이미 작성되어 있더라도 확인 차원에서 한 번 더 요청하겠습니다.