[GitHub] README.md 작성법

 

🔽 GitHub 사용법은 아래 포스트를 참고해주세요 🔽

 

[GitHub] 왕초보를 위한 깃허브 사용법 총정리

 

---

 

🔗 README.md(리드미)란? 써야 하는 이유?

 

 'read me'는 문자 그대로, 읽으면 도움이 되는 정보가 들어 있는 텍스트 파일입니다. 설치 방법이나 그에 대한 보충 설명, 매뉴얼에 기재되어 있지 않은 정보가 포함되어 있으므로 반드시 읽어야 합니다. 일반 문장의 서술 형식으로 디스크에 수록되어 있어 워드 프로세싱 프로그램으로 쉽게 읽을 수 있습니다.

 

---

 

🔗 README.md(리드미) 안에 들어갈 내용

 

README	일반 정보
AUTHORS	제작 정보
THANKS	도와주신 분들에 대한 정보
ChangeLog	프로그래머들이 참고 할 수 있는 자세한 체인지 로그
NEWS	사용자들이 참고할 수 있는 자세한 체인지 로그
INSTALL	설치 안내
COPYING/LICENSE	저작권 및 사용권 정보
BUGS	알려진 버그 및 새로운 버그 보고 방법 안내

출처 - 위키백과

 

---

 

🔗 README.md(리드미) 작성법

 

 

1. 줄바꿈

 

Enter 2번 OR 마지막 줄에 스페이스바 2번 

 

 

2. 제목

 

# H1
## H2
### H3
#### H4
##### H5
###### H6

 

 

3. 번호 없는 목록

 

* 목록1
  * 목록2
    * 목록3

+ 목록1
  + 목록2
    + 목록3

- 목록1
  - 목록2
    - 목록3

 

 

4. 번호 있는 목록

 

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

 

 

5. 글씨 설정

 

**진하게**
__진하게__

*기울이기*
_기울이기_

~~취소선~~

 

 

6. 구분선(수평선)

 

***
---

 

 

7. 코드 블록

 

```
코드 블록
```

```c
printf("문법이 있는 코드 블록\n")
```

 

 

8. 인용

 

> 인용1
>> 인용2
>>> 인용3

 

 

9. 링크 첨부

 

[누르면 링크로 이동](링크 주소)

<링크 주소>

 

 

10. 이미지 첨부 (아래 포스트를 봐주세요!)

 

[GitHub] README.md에 이미지 추가하는 방법

 

---

💡 같이 보면 좋을 Post

[Git] 깃(Git)이란? 깃허브(Github)란? / 차이점

[GitHub] 왕초보를 위한 깃허브 사용법 총정리

[GitHub] README.md에 이미지 추가하는 방법