1. README 란?

• 프로젝트에 대한 설명, 사용방법, 라이센스, 설치법과 같은 부분에 대해 기술하는 파일
• 나, 직장동료, 프로그램 사용자를 위해 존재

• README 예제

2. Markdown

• 실습방법
  • GitHub 에서 README 파일 수정을 선택

• 파일 수정 후 Commit

Headers - 큰 제목

Headers - 작은 제목

Headers - 글머리 (1~6 까지 지원)

• 위 큰 제목, 작은 제목 보단 글머리를 많이 씀

BlockQuote

• 블럭인용문자 사용(>)

BlockQuote (혼합)

• 블럭 내에서 다른 Markdown 요소를 포함할 수 있음

목록 - 순서가 있는 목록

• 내림차순으로 자동 정렬됨

목록 - 순서가 없는 목록

목록 - 순서가 없는 목록

목록 - 순서가 없는 목록 (혼합)

코드블럭 1

<pre><code>{code}</code></pre>

• 앞뒤 pre 를 뺄 수도 있다.
• pre 를 빼면 코드블럭이 끝까지 가지않고, 텍스트 만큼만 오게된다

코드블럭 2

```{code}```

수평선

외부링크

자동연결

강조

이미지

• 이미지가 어딘가 업로드 되어 있어야 함
  (업로드 되어있는 주소(path)를 가져와서 링크를 거는 구조임)

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

• 이미지 (GitHub)
  • GitHub 저장소에서 New Issue 클릭

• Text Area 에 이미지 업로드(드래그) 하면 Markdown Link 가 생성 > 복사
그냥 아래 네모칸에 주소 넣고 기다리면 링크주소가 생성됨, 그걸 복사해서 그냥 쓰면 됨. 아래 submit~~ 이거 클릭 안해도 됨

• README 에 붙여넣기

• README 에 붙여넣기

위 글은 제로베이스 데이터 취업 스쿨의 강의자료를 참고하여 작성되었습니다.