마크다운

확장자가 .md(mark down)인 텍스트 파일
ex) README.md

• 왜 사용하는가 : 가독성의 증대 (읽기 쉽게, 쓰기 쉽게)
• 어디서 쓰는가 : github, velog, notion, TISTORY, Discord 등

작성방법

제목작성

# 		제목1
## 		제목2
### 	제목3
#### 	제목4
##### 	제목5
###### 	제목6

결과

제목1

제목2

제목3

제목4

제목5

제목6

# 작성은 역슬래시 + #
개행 : github에서는 공백두칸+엔터

목록

순서가 있는 목록

n + . 사용하여 작성

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

순서가 없는 목록

-, +, * 을 사용하여 작성

• 목록
• 목록
• 목록

글꼴

기울이기

_기울이기_

굵게

**굵게**

기울여 굵게

**_기울여 굵게_**

코드

// `기호 세 번 ``` 사용

인용문

> 기호 사용

>> 중첩도 가능

---

readme

협업을 잘하려면 코드공유와 문서공유가 잘되야 한다

README 파일의 역할

• 프로그램의 설명
  - 프로그램 사용 방법
  - 래퍼런스(본인, 협업, 사용자)

• 구현중인 프로젝트의 현황
  - 구현된 주요 기능
  - 구현 현황
  - 코드가 해결해야하는 문제
  • 지침서의 역할

README 파일의 구성

• 프로젝트의 구성
• 프로젝트의 설치/사용 방법
• 참여자
• 버그 및 디버그 관리
• 참고 및 출처
• 버전관리

마크다운을 사용하여 가독성을 높일 것

---

버전 관리

버전 : 이전과의 변화를 구분, 프로그램을 수정, 개선하여 새로워 지는 것

• 변화가 유의미해야만 새로운 '버전'이라고 부를 수 있음

버전 관리 시스템의 종류

VCS (Version Control System)

• 로컬 VCS : 내 컴퓨터에서만 가능 (협업불가)
• 중앙집중식 VCS : 다른 컴퓨터(중앙)에 백업파일을 보관하며, 필요한 파일만 가져와서 작업 (버전관리, 백업관리, 복구가능)
  대표적인 시스템으로서 SVN, CVS 등이 있다
• 분산 VCS : 프로젝트(폴더)를 전부 가져와서 작업 ('중앙집중식'보다 관리 범위가 함축되어 안정적)
  대표적인 시스템으로서 Git, Mecurial, Bazaar