마크다운을 이용한 리드미 작성

마크다운?

마크다운(markdown)은 일반 텍스트 기반의 경량 마크업 언어다. 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징이다. HTML과 리치 텍스트(RTF) 등 서식 문서로 쉽게 변환되기 때문에 응용 소프트웨어와 함께 배포되는 README 파일이나 온라인 게시물 등에 많이 사용된다.

how to use

마크다운(Markdown) 사용법
https://gist.github.com/ihoneymon/652be052a0727ad59601
사실은 내가 보기위한 마크다운 문법설명서
https://gist.github.com/ninanung/946cd0e2e09bd5a94964ff8b612a9012
위키백과 : 마크다운
https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4

리드미는 중요함

중요한 이유

1. 시간이 많이 지나고 나서 코드를 봐도 이해할 수 있게 해줌
2. 다른 사람이 프로젝트를 이해하는 데 필요함

원칙을 세우면 좋다

리드미는 꾸준히 작성하기 어렵다. 아래는 도움이 될 만한 원칙이다.

1. 기능을 구현하기 전에 README.md 파일에 구현할 기능 목록을 정리해 추가한다.
2. 커밋하는 기준을 앞 커밋에서 명시한 기능 목록 단위로 한다.
3. 필요한 정보들만 빠르게 캐치할 수 있도록 간단 명료하게 작성한다.

• 리드미 파일에 작성하는 기능 목록은 구현을 하면서 변경될 수 있다. 따라서 완벽하게 정리해야한다는 부담을 가지지 말자. 계속해서 업데이트를 하다보면 점점 정리된다.