[Markdown] 마크다운, Read me 실습해보기

프로젝트 관리의 중요성

프로젝트란? 

: 하나의 프로그램(시스템)을 만들기 위한 일련의 프로세스 

-> 소스 코드 구현 뿐 아니라, 어떤 프로그램을 만들기 위한, 아래와 같은 모든 과정 포함

- 기획 / 설계 / 테스트 / 배포 ...

 

프로젝트의 범위? -> 크기, 성향따라 설정하기 나름! 

 

협업을 위해

- 모두가 '공유'를 다 잘해야함 (코드 / 문서) 

 

=> 리드미 Read me

1️⃣ 완성된 프로그램의 설명서 

- 프로그램 사용 방법 

- 레퍼런스

2️⃣  구현중인 프로젝트의 현황 🌟

- 구현된 주요 기능

- 구현 현황

- 코드가 해결해야하는 문제 등

=> 프로젝트의 성공과 직결됨.

---

Readme 작성법 'Markdown'

확장자

• .txt : 텍스트 파일
• .jpg : 그림 파일
• .mov : 동영상 파일
• .m(ark)d(own) : 파일

 

✔️ Readme.txt

// 코드 구현 내용, ...

-> 꾸며지지 않고, 구성없이 글씨만 적힘 

 

✔️ Readme.md

// 코드 구현 내용, ...

-> 가독성 높은 텍스트로 

 

markdown이란?

: 일반 사용자들도 웹에서 쉽고 예쁘게 글을 쓸 수 있게 제공하고 있는 하나의 기술, 즉 단순했던 텍스트를 웹 기술로 바꿔주는 하나의 도구. 

 

주요목적  - 읽기 쉽게 / 쓰기 쉽게 

 

주요 문법

•  _글씨_ : 기울어서
• **글씨** : 굵게
• #(갯수별로) : 글자 타입
• 역슬래쉬(\) : 개행
• 코드 : ``` (1 옆, ~ 키) or 공백 4칸
• > : 인용문, 강조 

 

실습

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

-   순서가 없는 목록
-   순서가 없는 목록
-   순서가 없는 목록
-   순서가 없는 목록

_글씨_ : 기울어서  
**글씨** : 굵게  
**_글씨_** : 기울여 굵게

#(갯수별로) : 글자 타입2단계 제목4단계 제목

# 1단계 제목

## 2단계 제목

### 3단계 제목

#### 4단계 제목

##### 5단계 제목

역슬래쉬(\\) || : 개행  
코드 : \` 3개 (1 옆, ~ 키) or 공백 4칸  
```
print("hello")
//코드 안
```

\>: 인용문, 강조

> 인용문1

> 인용문2

> 인용문3

 

결과 화면 : https://ilove-ya.tistory.com/83

---

 

Github-Flavored Markdown

github에서 사용하는 markdown, 디스코드도 동일. 

 

깃허브 배우러가기 

https://ilove-ya.tistory.com/85