프로그래머스 데브코스, 국비지원교육, 코딩부트캠프

🚩프로그래머스 데브코스 웹 풀사이클 과정 1주차 DAY 2

---

오늘은 프로젝트 관리의 중요성, Readme에 대해, 그리고 버전 관리에 대해 배웠다. 다른 내용은 대부분 이론이었기에 오늘은 앞으로의 깃허브 생활에서도 아주 유용하게 쓰일 Readme에 대해서 중점적으로 적어보려고 한다.

📋 Readme

---

Readme에 대해서는 들어본 사람이 많을 거라고 생각한다. 보통 소프트웨어가 배포될 때 Readme라는 이름의 파일이 함께 포함되어 있는 걸 볼 수 있을 거다.
깃허브 Repository 내의 Readme를 확인해 보면 하나의 프로그램을 완성한 이후 해당 프로그램에 대한 설명을 보기 쉽게 정리해두기도 하고, 프로젝트를 진행할 경우 프로젝트에서 구현 기능, 구현된 현황 등을 정리해두기도 한다. 나도 학교에서 프로젝트를 진행할 때 Readme.md에 프로젝트에 대한 설명, 테스트 현황 등을 기록해두는 경우가 많았다.
Readme의 확장자가 반드시 .md 일 필요는 없지만 깃허브에서는 보통 .md 확장자, 즉 마크다운 형식을 사용한다.

🤷 마크다운?

---

그래서 마크다운이 무엇인가?

마크다운(Markdown)은 일반 텍스트 기반의 경량 마크업 언어다. 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징이다.
출처 : 위키백과

굳이 마크다운을 사용하는 이유는 간단하다. 작성자가 쓰기 쉽고, 읽는 사람이 보기 쉽게 하기 위함이다.

마크다운을 사용하는 곳은 아주 많다. 당장 이 velog만 하더라도 마크다운 문법을 사용하고 있으니까... 이외에도 노션, 티스토리 기타 등등. 문법이 간결하고 가볍기 때문에 배우는 것도 어렵지 않다.

✏️ 마크다운 사용법

---

🌸 제목

# h1
## h2
### h3
#### h4
##### h5
###### h6

👉 결과

h1

h2

h3

h4

h5

h6

#의 개수가 많아질수록 크기는 작아진다.
velog 내에서는 H1~H4까지밖에 없지만 기본적으로 마크다운 문법이기 때문에 H6까지 전부 지원이 된다. 그리고 velog에서는 이 제목 태그를 사용하면 자동으로 목차가 만들어진다. 아마 오늘 목차는 지저분해질 예정...

🌸 목록

1. 순서 있는 목록
2. 순서 있는 목록
3. 순서 있는 목록

👉 결과

1. 순서 있는 목록
2. 순서 있는 목록
3. 순서 있는 목록

- 순서 없는 목록
* 순서 없는 목록
+ 순서 없는 목록

👉 결과

• 순서 없는 목록

• 순서 없는 목록

• 순서 없는 목록

번호를 사용하면 번호로 정렬이 되고, '-, *, +'를 사용하면 번호 없는 동그라미로 목록이 만들어진다.

---

🌸 구분선

'---' 입력
딱히 꼭 개수를 세개를 맞출 필요는 없지만 세 개 이상은 필요하다.
이 외에도 _나 *를 세 개 이상 사용하면 된다.

👉 결과

---

🌸 코드블럭

'```', 혹은 '~~~' 입력
작은 따옴표가 아닌 키보드 ESC 밑의 백틱임에 유의!!!

```javascript
console.log('Hello World!')
// 코드에 색을 입히고 싶다면 코드블럭 시작점에 사용하는 언어 명시!

```python
print("Hello World!")

👉 결과

console.log('Hello World!')
// 코드에 색을 입히고 싶다면 코드블럭 시작점에 사용하는 언어 명시!

print("Hello World!")

---

🌸 인용문

> 인용문
>> 중첩도 가능!!
>>> 중첩의 중첩도 가능!

👉 결과

인용문

중첩도 가능!!

중첩의 중첩도 가능!

---

🌸 텍스트 강조

**굵게**
_기울이기_
~~취소선~~

👉 결과

굵게
기울이기
취소선

---

🍀 마치며

위와 같은 마크다운 문법을 활용하여 깃허브에서 Readme.md 파일을 작성할 일이 아주 많을 거다. 이외에도 많은 문법이 있지만 우선 오늘 배운 내용과 가장 많이 쓰이는 것들 위주로 정리해보았다. 앞으로도 힘내자!!