개발/Git
READ.md 작성법!
오호츠크해 기단
2022. 11. 24. 18:14
728x90
README는 해당 소프트웨어(프로그램)에 대한 정보(ex 사용법, 저작권, 프로젝트에 대한 설명 등)들을 기입해놓은 문서 파일이라고 생각하면 된다.
README.md 파일의 작성은 MARKDOWN을 사용합니다. 확장자 md가 바로 이 MARKDOWN의 확장자이다.
깃허브에서 레파지토리에 README 파일을 추가하지 않으면
레파지토리 하단에 아래 사진과 같이 README를 추가하라는 안내문구를 띄워준다.
MARKDOWN 문법
1. 제목(글머리) 작성
*#뒤 공백 넣기
# H1, 제목
## H2, 부제목
### H3, 소제목
#### H4, 제목4
##### H5, 제목5
###### H6, 제목6
2. 번호 없는 리스트 작성
* 리스트 1
- 리스트 2
+ 리스트 3
Tab을 통해서 소속을 만들 수 있으며,
*, -, + 총 3가지 기호는 동일한 출력 결과를 가져온다.
3. 번호 있는 리스트 작성
1. 리스트 1
2. 리스트 2
3. 리스트 3
4. 이텔릭체(기울어진 글씨) 작성
-언더바 1개(_)
*텍스트* 혹은 _텍스트_
5. 굵은 글씨 작성
-언더바 2개(__)
**텍스트** 혹은 __텍스트__
6. 인용
> 텍스트
> > 텍스트 ( > 기호 하나 더 추가할 경우 인용문 안에 또 인용문 추가)
7. 수평선 넣기
하단의 기호 3개 이상 나열
***
---
___
8. 링크 달기
(1) 인라인 링크
[텍스트](링크 주소)
(2) 참조 링크
[텍스트][참조명]
[참조명]: 링크 주소
9. 이미지 추가하기
ex) 마크다운 형식
tip) 이미지 크기 조절_HTML 형식
<img src="이미지 링크" width="너비 " height="높이">
ex)
<img src="https://user-images.githubusercontent.com/102302841/203743254-6db8b578-01d8-4d17-892d-bc5e108ae707.jpg" width="100" height="200">
+이미지 링크: 하단에 이미지링크 추출하는 법 참고
+마크다운 형식은 이미지 크기 조절 불가!
10. 동영상 추가하기
이미지 추가와 방법이 비슷하다.
*깃허브(GitHub)에 동영상 파일을 직접적으로 업로드하기는 쉽지 않다. 그래서 일반적으로 MP4 확장자를 GIF 확장자로 변형한 뒤에 업로드한다. 아래 사이트에 방문하면 쉽게 변경할 수 있다.
cloudconvert.com/mp4-to-gif
위 사이트로 접속해 video->gif로 변경
gif로 변경이 완료되면 다운로드 해서 사용하면 된다.
11. 코드 블록 추가하기
```
코드
코드
코드
```
만약 문법이 있는 언어를 코드 블럭에 넣고 싶다면 맨 첫번째 ```뒤에 언어 표시하기
``` C
printf("Hello World!\n");
printf(("Code Block\n");
```
(주의! 작은따옴표X, 억음 부호O / 맥의 경우, option 키 + ~키(₩키), 윈도우의 경우 ~기호 아래에서 찾아볼 수 있다.)
etc.
[글씨 취소선 넣기]
~~텍스트~~
[체크박스 넣기]
* [x] 체크박스
* [ ] 빈 체크박스
[표 넣기]
|왼쪽 정렬|가운데 정렬|오른쪽 정렬|
|:---|:---:|---:| // :의 위치가 정렬을 결정
|내용1|내용2|내용3|
|내용1|내용2|내용3|
+Github README.md에 이미지 추가하는 방법
1. 깃허브 레포지토리에서 이슈 클릭
2. New issue 클릭
3. 이미지 드래그 & 드랍
4. 생성된 텍스트 복사해서 사용! _마크다운 방식
5. 이미지 추출 후 해당 이미지 클릭하면 이동하는 url 복사해서 사용! _HTML 방식->크기 조절 가능