README.md

README에 이거는 있어야 한다. 라고 생각됐던 부분들

 

Project Description

Installation

Compile, Test, Build Method

Environments

 

웹 프로젝트라면

Browser Supports도

 

 

라이브러리 혹은 API Server 일 경우엔

Examples, Documentation 도 포함해야하며, 

 

Contributor를 위해 rules를 묘사해주는 것도 좋다.

 

License가 지정을 해야한다면 선택하자.

 

뱃지를 활용하면 현재 프로젝트 상태를 확인하기 쉽다.