README.md

README.md

• 프로젝트 설명서, 가이드라인.
• GitHub의 원격 저장소에 방문한 사람(나, 동료, 사용자)을 위해 프로젝트의 전체적인 내용을 기록한다.
• 목적, 실행, 구조, 과정, 의의 등 설명이 필요한 부분을 담는다.
• .md 확장자는 .txt와 유사한데, Git에서만 사용하는 확장자이다.
• .md는 MarkDown의 약자로, 마크다운 언어를 사용한다.

MarkDown

• 텍스트 기반의 MarkUp 언어
• 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다.
• 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다.

 

문법

아래 링크에서 선생님의 글을 참고하자.

GitHub여서 예시와 함께 설명이 잘 되어 있다.

https://gist.github.com/ihoneymon/652be052a0727ad59601

마크다운(Markdown) 사용법

 

이모지

아래 링크의 선생님께서 이모지 표를 적어두셨다.

좀 더 멋들어지게 꾸밀 수 있다.

https://inpa.tistory.com/entry/MarkDown-%F0%9F%93%9A-Emoji-%EC%9D%B4%EB%AA%A8%ED%8B%B0%EC%BD%98-%EC%82%AC%EC%9A%A9%ED%95%98%EA%B8%B0

🏷️ 마크다운 emoji 이모티콘 사용하는 방법

 

활용

README.md를 처음 작성했다.

깔끔하게 정리해 두니 좀 더 가독성이 좋아져서 구현할 때 요구 사항을 확인하기 수월할 듯하다.

멋쟁이 이모지들로 프로젝트 시작을 멋지게 할 수 있다.

이제 적어둔 대로 꼼꼼히 구현해보자.