본문으로 바로가기

README.md 10초만에 깔끔하게 만드는 법

category Study/Back-End Dev 2019.06.15 06:46

GitHub을 보다보면 README 파일이 정말 깔끔하게 잘 만들어진 레파지토리가 있죠. 그래서 저도 그렇게 잘 만들어진 README 파일을 많이 따라하려고 하는데요. 근데 이게 익숙하지 않다면 생각보다 effort가 많이 들어갑니다. 그러다 오늘 우연히 오픈소스를 하나 발견했는데요. 이걸 쓰면 정말 간단하고 빠르게 깔끔한 README 파일을 만들 수 있더군요.

 

readme-md-generator

이 오픈소스는 readme-md-generator 입니다. 레파지토리 주소는 아래 링크로 들어가시면 되고요. 간단하게 소개 드리자면 질답 형식으로 readme 파일을 생성해주는 generatior입니다.

 

readme-md-generator GitHub 링크

 

프로젝트 이름이랑 버전, 라이센스 등 정보를 입력하면 아래와 같이 깔끔하고 전형적인 README.md 파일이 만들어집니다. 써보니 정말 간단하더군요. 

 

만들어진 readme.md 예시

이렇게 오늘은 README 파일을 빠르게 만들 수 있는 오픈소스 하나를 소개드려봤습니다. README 파일이 왜 중요한지는 다들 아실거라고 생각합니다. 아무리 소스를 잘 짜서 GitHub에 올려놔도 README가 성의 없으면 좀 그렇잖아요? 개인적으로도 좋은 개발자는 문서 정리도 깔끔하게 해야 된다고 생각하고 있어서.. 저도 뭐 아직 많이 부족하지만 쿨럭.. 아무튼 README 파일 만들 때 조금 번거로우셨던 분들은 한 번 이용해보시길 추천해볼께요.

 

** 336x280 **

 

 

Web Application Development with JavaScript and MongoDB | Coursera

Learn Web Application Development with JavaScript and MongoDB from 런던 대학교, 골드스미스 대학교. In this course, you will develop more advanced web application programming skills. You will learn how to control data read and write access using methods, ...

www.coursera.org

 


댓글을 달아 주세요