[TIL][Github] 리드미(README.md)

README.md 작성하기

내일배움캠프에서 한 주간 진행하던 개인 프로젝트가 오늘 제출하며 마무리 되었다. 혼자 작은 규모의 프로젝트를 진행하며 겪은 어려움에는 정말 다양한 것들이 있었지만 프로젝트가 마무리 될 무렵 마주한 어려움이 가장 당혹스러운 어려움이였다. 그것은 바로 리드미 작성하기였다.

 

마크다운(Markdown)

리드미를 작성하며 겪었던 첫 어려움은 바로 '생소함'이였다. 일반 블로그와 같이 마우스로 상호작용하여 글을 써내려가는 방식이 아닌 오로지 텍스트 문법을 통해 꾸며나가야 하는 문서였기 때문에 현재 티스토리 블로그를 사용하는 나로써는 쉽게 작성할 수 없었다. 그렇다면 도대체 마크다운이 뭘까?

마크다운(Markdown)은 텍스트 기반의 마크업 언어로 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다는 특징이 있다. 이 한 문장으로만 보자면 사실 이런 문서를 사용하는 이유에 대하여 쉽게 납득하기 어렵다. 대부분의 사람들은 티스토리와 같은 글쓰기를 더 많이 접해봤기 때문이다.

다음은 마크다운의 장점을 정리한 것이다.

• 간결하다.
• 별도의 도구 없이 작성 가능하다.
• 다양한 형태로 변환이 가능하다.
• 텍스트로 저장되기 때문에 용량이 적어 보관이 용이하다.
• 텍스트 파일이기 때문에 버전 관리 시스템을 이용하여 변경 이력을 관리할 수 있다.
• 지원하는 프로그램과 플랫폼이 다양하다.

정리된 장점을 보자면 마크다운의 가장 큰 강점은 간결함과 범용성이다. 간단한 문법만 알면 쉽고 빠르게 사용할 수 있는 장점이 있기에 사용된다.

 

https://github.com/twotop6357/FledglingKnight/blob/main/README.md

FledglingKnight/README.md at main · twotop6357/FledglingKnight

위 깃헙 주소는 이번 개인 프로젝트를 진행하며 작성한 리드미이다. 이번이 마크다운을 처음 접해본 상황이기도 하고 시간도 부족하여 화려하게 꾸미지는 못하였으나 꽤나 가독성이 좋게 정리되는 모습이다. 마크다운을 계속 접하며 작성 요령을 터득할수록 내 프로젝트에 대해 알리는 글을 더 간편하게 작성할 수 있을 것이라는 기대가 있다.

 

24.05.14 Today I Learned