[GitHub] Readme.md 작성 방법

README 파일이란?

README란 프로그램 소개글으로, 저장소에 대한 이해를 돕기 위한 파일이라고 생각하면된다!

디렉토리나 압축파일에 포함된 기타 파일에 대한 정보를 포함하고 있으며, 일반적으로 소프트웨어와 함께 배포된다. 

 

 

 

README 생성법

저장소를 생성할 때 "Add a README file"에 체크하여 저장소를 생성하거나

 

 

저장소를 생성하고 난 뒤 "CREATE README" 를 선택해서

 

"Commit new file"을 선택하여 생성

 

 

 

마크다운(Mark Down) 사용법

이렇게 생성된 README 파일은 마크다운을 이용하여 수정할 수 있다. 

 

 

1. 제목 생성

# 가장 큰 크기의 텍스트 1
## 그 다음 작은 크기의 텍스트 2
### 그 다음 작은 크기의 텍스트 3
#### 그 다음 작은 크기의 텍스트 4
##### 그 다음 작은 크기의 텍스트 5 
###### 그 다음 작은 크기의 텍스트 6

#과 텍스트 사이에 여백을 한칸 두고 마크다운을 작성하면 제목을 생성할 수 있다. 

#의 개수에 따라 글씨의 크기가 달라진다. 

 

 

 

2. 가로 줄

---
- - -
***
* * *

위의 4가지 방법 중 하나를 선택하여 입력하면 다음과 같이 가로줄을 생성할 수 있다. 

 

 

3. 텍스트 강조

**텍스트 강조**
__텍스트 강조__
*글씨 기울이기*
_글씨 기울이기_
***굵게 기울이기***
___굵게 기울이기___
~~취소선~~

**이나 __를 앞뒤로 사용해주면 텍스트 굵게

*이나_를 앞뒤로 사용해주면 텍스트 기울이기

***이나 ___를 앞뒤로 사용해주면 텍스트 굵게 기울이기

~~을 앞뒤로 사용해주면 취소선

 

 

 

4. 목록

+ 목록1
- 목록2 
* 목록3

"+" ,"*", "-" 중 하나를 선택하여 사용하면 순서없는 목록을 만들 수 있다. 

(두번 "ENTER" 안해도 줄 달라짐)

 

+ 목록1 
  + 목록 1-1 ##[Tab Key]
  + 목록 1-2  
    + 목록 1-2-1 ##[Tab Key][Tab Key]
- 목록2 
  - 목록 2-1
* 목록3
  * 목록 3-1

"Tab Key"를 사용하면 여러 단계의 목록을 만들 수 있다. 

 

 

 

 

5. 인용

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

인용문 앞에 ">"키를 넣으면 인용문을 생성할 수 있다. 

">>" 사용하면 인용문 안에 인용문 생성 가능

 

 

 

 

6. 코드 블록

```Python
print("hi")

Grave 기호(`) 뒤에 사용하고자 하는 언어를 입력한 후, 코드 블록을 삽입할 수 있음

(숫자1 자판 옆에 있음)

 

 

 

 

7. 링크

<https://suhye.tistory.com/>

[TStory](https://suhye.tistory.com/)

[Tstory](https://suhye.tistory.com/, "티스토리")

<링크주소>

[대체 텍스트](링크주소)

[대체 텍스트](링크주소, "설명")

 

 

8. 이미지 삽입

 

저장소의 "issue"에 들어가서

 

올리고자 하는 이미지를 Drag&Drop으로 넣은 후 복사!

 

 

README 파일에 붙여넣기 해주면

 

이미지를 붙여넣을 수 있다.