Github 레포지터리를 들어가면 가장 먼저 볼 수 있는 것이 Readme.md이다.
내 프로젝트를 잘 알리고, 사람들이 유입되어 활성화 시키기 위해선 좋은 Readme를 작성하여야 한다.
Readme를 작성할때 포함하면 좋은 내용들
1. 프로젝트의 목적 및 용도
프로젝트에 대해 간단하게 설명하는 내용을 포함하는 것이 좋다.
- 이 프로젝트는 무엇을 위한 것인가
- 어떤 문제를 해결할 수 있는가
- 왜 이 프로젝트가 유용한가
- 어떤 사람들이 이 프로젝트를 사용하면 좋은가
- 이 프로젝트는 어떻게 작동하는가
2. 프로젝트를 시작하는 방법
프로젝트를 처음 사용하기 위해 필요한 내용을 포함하는 것이 좋다.
- 프로젝트를 설치, 사용하기 위해 필요한 전제조건이 있는가
- 어떻게 설치, 사용, 테스트하는가
- 설치 가이드 문서는 어디에 있는가
3. 저작권, 라이선스 정보
프로젝트의 사용 범위 및 조건을 설명하는 내용을 포함하는 것이 좋다.
- 어떤 라이선스로 배포되는가?
- 상세한 라이선스 정보는 어디에서 확인할 수 있는가
- 프로젝트를 사용함에 있어 제약 조건이 있는가(특허, 상업적 사용)
4. 외부 리소스 정보
프로젝트 내에 포함된 외부의 코드나 리소스의 정보를 포함하는 것이 좋다.
- 각각의 출처 및 배포 라이선스는 무엇인가
결론
좋은 Readme를 작성할때, 포함하면 좋은 내용들을 간단하게 확인해 보았다.
좋은 템플릿을 만들어 놓은 페이지도 있고, 여러 대형 프로젝트 레포지터리를 구경다니면서 좋은점을 추가해나가는것도 좋다고 생각한다.
받은만큼 나눠주자