출처 :
간단히 말해서, 리드미 파일은 사람들에게 여러분이 작업한 프로젝트에 대해 구체적인 설명을 제공하는 가이드라고 보시면 됩니다.
프로젝트를 어떻게 사용할 수 있는지에 대한 가이드 문서라고도 설명할 수 있겠네요. 일반적으로 리드미 파일은 프로젝트 설치 방법과 실행 방법을 명시합니다.
여러분이 개발자로서 리드미를 작성하며 프로젝트를 문서화할 줄 아는 것이 중요한 이유는 다음과 같습니다:
훌륭한 작가는 자신의 생각뿐만 아니라 친구들의 생각까지 마음에 품고 있다.
프로젝트를 할 때, 다른 개발자들이 여러분의 코드를 이해해야 한다는 점을 염두에 두어야 합니다. 그래서 추가적인 가이드를 포함하는 것이 큰 도움이 될 것입니다.
예를 들어, 위에서 공유했던 제 첫 번째 프로젝트의 리드미는 형편없었죠. 프로젝트 자체는 훌륭했지만 초심자가 제 레포지토리를 클론하면 정확히 무엇이 일어나는지 이해하기 힘들었을 것입니다. 그 파일에 바이러스가 있는지 누가 알겠어요.
깃허브에 이런 프로젝트를 올리면, 얼마나 훌륭한지에 상관없이 다른 개발자들은 잘 쓰여진 리드미가 없으면 그 프로젝트에 대해 알아보거나 작업하고 싶지 않을 것입니다.