[Git]README.md 작성법 README 란?

README

• 파일이나 프로젝트 등에 포함된 정보
• 보통 소프트웨어가 배포될 때 함께 포함되어 있음

why

README 가 필요한 이유

1. 본인을 위하여

   자신이 코딩한 프로그램이더라도, 다시 읽어보고 해석해야 이해가 가능 경우가 많다. 미래를 위해서 미리 Readme 를 작성해놓으면 필요할 때 프로그램을 이해하기 수월하다.

2. 협업하는 동료들을 위하여

   함께 프로젝트를 할 때, 지침서 역할로 유용하다.

3. 사용자들을 위하여

   서비스를 구현하거나, 프로젝트가 오픈소스라면 이용자들을 위한 지침서로 유용하다.

How

• 정해져 있는 양식이 존재하는 것은 아니다.
• txt, md 등등 다양한 형식을 사용할 수 있다.
• github에서는 보통 Markdown 형식의 README.MD 를 사용하고 권장한다.
• 간단명료한 것이 효율적이다.

구성요소

• 프로젝트 구성

• 프로젝트 프로그램 설치 방법

• 프로젝트 프로그램 사용법

• 저작권 및 사용권 정보

• 프로그래머 정보

• 버그 및 디버그

• 참고 출처

• 버전 및 업데이트 정보

• FAQ

ex)

네이버 오픈소스 모음

NaverOpensource

• 각 프로젝트의 github 에서 README.md 를 열어보면, 어떤 형식으로 작성되는지 알 수 있다.

---

github 에서 README.md 작성하기

README.md

• github 에서 프로젝트를 진행할 때, 자주 사용되는 Markdown 형식의 파일이다.

Markdown 언어의 문법 및 사용법 링크 :

Markdown 언어란