좋은 README.md 만들기

좋은 README.md 만들기 가 필요한 이유 

git repositorise 에 접근하게 되면 제일 먼저 보게 되기 때문

코드만 보고서 해당 프로젝트가 어떤 프로젝트인지 어떤 이유로 아래와 같이 코딩을 했는지 확인 하기가 어려움

 

템플릿  예시 

 

프로젝트 제목

프로젝트 목적과 용도 적기

 

시작하기

프로젝트 실행에 필요한 항목 설명

설치 와 실행 가이드 적기 (스탭으로 나누어서 순서대로 알려주는 것이 좋음)

 

빌드에 사용된 것 들

 

버전정보

 

작성자 

(프로젝트 기여자 목록도 참조)

 

라이선스 

저작권 라이선스 정보 적기 

 

외부 리소스 정보 

외부 리소스 출처 및 링크 걸기 

 

 

 

참고 한 글 
https://gist.github.com/PurpleBooth/109311bb0361f32d87a2#getting-started