Information about writing ReadME documentation.

Anatomy of a README

  1. What steps need to be taken?
  2. What should the user already have installed or configured?
  3. What might they have a hard time understading right away?

Basic Structure

1
2
3
4
5
6
7
8
# 프로젝트 제목
프로젝트 설명 (with 프로젝트 Logo)

## 설치 방법 (Installation)
설치 방법 설명 (with 예시코드)

## 사용 방법 (Usage)
사용 방법 설명 (with 예시코드)
  • If it is Open Source Project
1
2
3
4
5
## 기여 방법 (Contributing)
기여 방법 설명

## 라이센스 (License)
해당하는 License (choosealicense.com 참고)
  • Big project
1
2
3
## 버그들 (Known Bugs)
## FAQ (Frequently Asked Qustions)
## ToC (Table of Contents)



ref : “Udacity - Writing READMEs”