[내배캠] 최종프로젝트 29. 최종 발표 준비 1. GitHub README 정리

README

README는 레포지토리를 방문한 사람에게 “이 프로젝트는 무엇인지” 를 알기 쉽게 전달해주는 중요한 역할을 한다. 처음 레포지토리 방문한 유저가 쉽게 알 수 있게 가독성을 생각하여 작성해야 한다.
README는 프로젝트를 진행하며 차근차근 작성하는 것이 좋다.
(개인적으로는 프로젝트 내용을 그때그때 Figma, Notion, blog 등에 기록하고 나중에 시간이 날 때, README에 가독성 좋게 정리하고 있다.)

들어갈 내용

• 무엇을 위한 것인가
• 이 프로젝트를 만들며 어떤 기술적 의사결정을 했는가
• 어떻게 작동하는가
• 이 프로젝트를 하며 어떤 트러블이 있었고 트러블 슈팅은 어떻게 진행했는가
• 이 프로젝트를 누구와 함께 만들었는가

가독성을 위한 마크다운 사용법 여러 가지

1. 문서 내 링크 설정
   README를 작성하다보면 목차를 적는 경우가 있는데, 목차에서 원하는 헤더로 바로 갈 수 있는 방법이 있다.

## 📖 목차
1. 👨‍🏫 프로젝트 소개 (<- 여기 클릭 시 이동하는 링크)

## 👨‍🏫 프로젝트 소개

위와 같이 이모지가 포함된 헤더에 링크를 걸고 싶으면 아래와 같이 작성하면 된다.

[표시될 내용](#링크(이동할 위치의 글자))
1. [👨‍🏫 프로젝트 소개](#-프로젝트-소개)

이때 주의할 점은 띄어쓰기는 -로 변경, 소괄호나 이모지는 무시, 영어일 경우 소문자로 작성해야 한다.

2. 링크

[표시될 내용](링크)

3. 토글

   여기에 토글 Title 작성

   여기에 내용 작성

위와 같이 토글을 만드는 방법

<details>
<summary>여기에 토글 Title 작성</summary>
<div markdown="1">

	여기에 내용 작성

</div>
</details>

4. 영상 썸네일 + 링크

[![Video Label](http://img.youtube.com/vi/"이 부분"/0.jpg)](https://youtu.be/"이 부분")

5. 간단한 이미지 크기 조절 방법

<img src="깃허브 리드미에 넣은 이미지링크" width = 50%> (or height = 50%)
원본 이미지의 width의 50% 크기로 설정

그 외

윈도우 이모지 입력: Window키 + .(마침표)