Chapter 10. README
10.1 README
1.10-1 MarkDown(마크 다운)
- MarkDown: 일반 텍스트 형식의 문서의 양식을 편집하는 문법
- 누구나 쉽게 읽고 쓸 수 있으며 HTML로 변환이 가능하다.
- 특수 기호와 문자를 이용한 매우 간단한 구조의 문법을 사용해 빠르게 작성하고 쉽게 읽을 수 있다. 코드 블럭도 작성 가능하다.
- MarkDown 태그의 종류
-> 제목: #, =====
-> 인용: >
-> 강조: *, _
-> 링크: [텍스트](주소 "설명 생략가능")
-> 이미지: 
-> 리스트: 1, *, -, +
-> 코드 표시: <code> 코드 </code> , 한 줄 띄우고 스페이스 4 칸, ```코드```
-> 가로선: -----, *****, +++++
cf) 마크다운 가이드 사이트가 있다. typora - 마크다운 리더 겸 에디터
Ex) 아래와 같이 작성하면 preview에서 확인 가능하다.
Ex) 실습하기
- README.md: 프로젝트를 설명하는 문서를 말한다.
-> 어떤 목적으로 개발되었는지 코드의 개요, 구조 , 빌드 방법, 사용법 등을 마크다운으로 작성한다.
-> 깃허브 페이지 상에 소스 코드 아래에 보여진다.
- 아래와 같이 만들고 커밋, push하면 README.md에서 만든대로 확인 가능하다.
-> 프레임워크에 따라 자동으로 파일이 생성되기도 한다.
Note) 정리하기
- 변경할 것들을 골라서 staging area에 add한다.
- 소스 파일이 변경된 시점들의 스샷을 등록 => commit
