수준급의 GITHUB README.MD 작성하기

Github README.md를 예쁘게 만들고 싶을 것이다. 오늘은 shields와 Eemoji 그리고 LICENSE를 이용해서 수준급의 README.md를 작성하는 방법을 알아볼 것이다.

내가 만든 예쁜 README.md 예시

Eemoji는 우리가 잘 아는 이모티콘을 의미한다. 예로 👜🕶👑🍁🎖🎨이러한 모든 것들이 Eemoji이다. README.md에서 적절한 부분에 Eemoji를 붙이면 훨씬 예쁜 ⭐README.md⭐ 파일을 작성할 수 있다.

emoji.muan에서 star를 검색한 예시

위 사이트를 이용해서 Eemoji들을 찾아서 이용해보자.

shields는 무엇일까? 아래와 같이 자신의 Github를 소개하는 뱃지 정도라고 생각하면 될 것이다. license, web, version 등을 표시할 수 있다.

shields.io에서 SUBJECT(제목), STATUS(상태), COLOR(색깔)를 지정하면 shields를 제작할 수 있다.

https://img.shields.io/badge/<SUBJECT>-<STATUS>-<COLOR>.svg 또는 여기서 직접 사용해도 될다.

https://img.shields.io/badge/shields-go-green.svg 위 shieds를 만드는 링크이다.

이제 이러한 방법들을 응응해서 더욱 예쁜 README.md 파일을 만들기 바란다.

LICENSE는 그냥 말 그대로 이 프로그램을 어디까지 사용해도 되는지 설명하는 것을 의미한다. 오픈소스 소프트웨어 라이선스 가이드 3.0 문서를 읽고 원하는 LICENSE를 선택하고 Github에 적용해보자.

프로젝트의 Insights에 들어가서

Cimmunity에 들어가서 License 부분에 Add를 클릭한다.

여기서 자신이 원하는 LICENSE를 선택하고 Review and submit을 눌러서 적용한다.

따라 하고 Merge pull request를 누르면

위 사진처럼 License가 적용돼 있다.

그리고 항상 Github에 업데이트한 내용이 있으면 git pull를 하는 것을 기억하자.

git pull origin master

더 많은 정보

그리고 더 많은 정보를 알고 싶으면 README.md 템플릿 을 참고 해서 자시만의 먼지 README.md파일을 만들기 바란다.