[GitHub] README.md 에 대해 알아보자

1. README.md 는 무엇인가?

---

README.md 는 깃허브 저장소 에대한 설명을 담고있는 마크다운(.md) 파일입니다.

여기에 코드의 개요, 구조도, 설계 등을 작성합니다 (일종의 설명서).

물건을 산뒤 설명서를 먼저 보듯이 개발자들은 깃허브 저장소를 볼때 README 파일을 가장 먼저 봅니다.(간혹 코드부터 보시는분들도 있긴한데 잘없습니다…)

따라서 깃허브에서 가장 중요한것은 역시 잘 정리된 README 라고 할수있을정도 !!

2. README.md 에 들어가야할 내용?

---

1. 간단한 설명

프로그램이 어떤 기능을 가지고 있는지에대한 간단한 설명

2. 실행환경

해당 프로그램을 작성한 OS,언어,기술,버전 에대한 설명, 이는 뱃지형태로 작성하면 좋다

3. 사용방법

해당 코드의 실행방법에 대한 설명을 작성한다 OS 별 설치 방법이나 (Install) 해당 코드의 사용예시를 작성한다.(Usage)

3. README 에서 뱃지 만들기!

---

뱃지이름과 색을 가지고올 수 있는 사이트 “https://simpleicons.org/”

<img src="https://img.shields.io/badge/뱃지이름-배지배경색?
          style=[배지의 모양 :(plastic, flat, flat-square, for-the-badge, social)
          &logo=로고명
          &logoColor=글자색(보통white)"/>