Github README.md 작성법

이 강의는 Udacity에서 무료로 제공하는 Writing READMEs 강좌를 요약한 내용입니다.

README 파일은 어떤 사람들을 위해 존재하는가?

1. 나

2. 직장동료

3. 프로그램 사용자 

일반적으로 README 파일은 영어로 작성되는데 README 파일을 읽어보는 사람들이 읽고 해석할수 있어야하므로 가장 무난한 영어로 작성한다.

내가 작성한 프로젝트일지라도 기간이 지나면 어떤 목적으로 이 프로그램을 개발하였는지 기억하지 못할 확률이 높아진다. README 파일은 이런 불상사를 막기위함이다.

README 파일이 작성되어있지 않을경우에 개발자들이 사용하지 않을 확률이 매우높다.

이미 작성된 README 파일들을 살펴보며 구성요소들을 알아보자

• README #1 - factory_girl
• README #2 - can.viewify
• README #3 - create-your-own-adventure

반드시 명심해야할 점은 이 README 문서는 사람을 위해서 작성된다는 점이다. 사람이 이해할수 있도록 작성하는 것이 가장 중요하다. README 파일을 작성하는데 정규화된 규칙은 없지만 큰틀은 존재할수 있다.

ReadMe 파일을 작성할 때에는 커밋한 소프트웨어의 내용에 따라 라이센스도 달라지는데 어떠한 라이센스를 기입해야할지 잘 모르겠다면 아래 사이트를 참고하여보자.

You can use Choose A License to help you, well... choose a license for your projects.

프로젝트 규모가 커진다면 README 파일에 추가하면 좋은 내용들은 아래와 같다.

1. 알려진 버그

2. 최근 질문

3. 컨텐츠 내용

또한 ReadME를 작성할때 아래 이미지에서 우측처럼 작성하는것이 가독성이 높다.

깃헙 마크다운은 아래 링크를 참조하도록 하자

https://help.github.com/articles/about-writing-and-formatting-on-github/

마크다운 문서를 프리뷰 하면서 작성해보고 싶다면 아래 도구를 활용해서 작성하면 편하다

 Dillinger