프로젝트를 멋지게 설명하는 README.md

README.md 

README.md 파일은 깃허브 저장소를 돌아다니다 보면 흔히 볼 수 있는 문서 파일입니다. 이 파일은 프로젝트의 내용을 설명하기 위해 사용하는 파일로써 프로젝트가 어떤 목적에 의해 개발되었는지, 어떻게 사용할 수 있는지 등을 적어 놓습니다. README 문서의 내용은 저장소의 메인 페이지에 노출되기 때문에, 다소 귀찮더라도 신경 써서 작성하는 것이 좋습니다.

GitHub는 저장소 최초 생성 시, README 파일을 작성할 수 있도록 안내하고 있습니다. 

잘 작성된 README 문서의 예시로 facebook React 저장소를 가져와 봤습니다. 링크를 타고 들어가 보면 사진 속 내용 외에도 더 많은 내용을 확인할 수 있는데, React 뿐만 아니라 깃허브에 등록되어 있는 대부분의 프로젝트들은 개발자들이 README 문서 작성을 꼼꼼하게 해 두는 편입니다.

이처럼 깃허브는 일반적으로 소스가 공개되기 때문에, 다음 이유에서 README 문서를 잘 작성해 두면 좋습니다.

• 개인: 문서를 통해 프로젝트를 나중에 다시 보더라도 이해하기 쉽다.
• 협업: 협업 시 팀원들이 참고하기 좋은 지침서 역할이 된다. (오픈소스로 사용 시 동일한 이유)

양식에 정답은 없지만, 한 번 이곳을 참고해 보세요 🤗

마크다운

README 파일의 확장자를 보면 md가 붙어있는데, 이는 Markdown(마크다운)을 의미합니다. 마크다운은 일반 텍스트 기반의 가벼운 마크업 언어 중 하나로, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징입니다. 텍스트 하나 작성하는데 문법이 필요한 것이 다소 불편할 수도 있지만, 어렵지도 않을 뿐더러 요즘은 블로그 포스팅할 때도 사용할 수 있어 익혀두면 정말 편합니다.

본문에서는 간단한 문법 몇 가지 정도만 살펴 보겠습니다.

GitHub Docs를 통해 마크다운 문법을 공부할 수도 있습니다.

제목

<!-- #과 제목 사이 한 칸 띄워야 함 -->
# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

줄바꿈 

<!-- 중간에 빈 라인 한 줄 추가 -->
첫 번째 줄

두 번째 줄

수평선

<!-- 똑같은 결과를 나타내므로, 아무거나 사용해도 됨 -->
***
---

순서 있는 목록 

1. 목록
2. 목록
3. 목록

순서 없는 목록 

<!-- 들여쓰기 하면 중첩을 만들 수 있음 -->
* 목록
* 목록
    * 하위 목록
* 목록

텍스트 강조

**내용**  <!-- 굵게 표시 -->
*내용* <!-- 기울기 -->

인용

> 인용할 내용

소스코드

<!-- 언어를 지정해야, 문법에 맞는 하이라이트 표시 -->
```javascript
console.log('hello world');
```

인라인 링크

<!-- 구글이라는 글자에 링크가 걸림 -->
[구글](https://www.google.com)

이미지 첨부