✍🏼 README.md 이렇게 시작해보기 ✍🏼
(아래 글은 Keys to a well written README를 요약했습니다.)
매번 README 구성에 대해 고민하는 초보 개발자라면
아래 글을 따라 가볍게 시작해봐도 좋겠다.
( 심지어 해당 글도 너무 깔끔하게 잘 썼다(!) )
* 기본 구성
- Title 제목
- Overview 개요 간략한 설명
- Features 이 프로젝트를 통해서 얻을 수 있는 것 혹은 기능(간략하게)
- Running the project clone 하는 사람들에게 어떻게 하면 프로젝트 실행시킬 수 있는지
- Dependencies 사용한 언어 및 라이브러리 기술등
* 추가 항목 (선택)
- ToDo List 투두리스트
- Contributors 기여자 도와준사람들
- Ways to contribute (기여하고 싶은 사람들을 위한) 기여 방법