리드미 개념, 마크다운 작성법

Readme.md, Readme.txt

응용 프로그램을 설치하거나 프로젝트를 내려받았을 때 "Readme.xxx"라는 이름의 파일을 종종 확인할 수 있다.

리드미는 무엇이며, 왜 존재하는 걸까?

 

리드미란?

리드미는 크게 두 가지의 역할을 하고 있다.

1. 완성된 프로그램의 설명서 (프로그램의 사용 방법, 레퍼런스 등)

2. 구현중인 프로젝트의 현황 (구현된 주요 기능, 개발 현황 등)

 

첫 번째 역할은 주로 프로젝트 또는 프로그램을 사용하려는 사용자들을 위한 역할이다. 

전자제품 또는 물건을 구매하고 사용하기 위해서 사용설명서를 읽어야 하듯이 프로젝트 또는 프로그램을 사용하기 위해서는 리드미를 읽어야 한다.

 

두 번째 역할은 주로 프로젝트를 개발하는 개발자들을 위한 역할이다.

협업을 진행하다보면 프로젝트의 진행 상황, 코드의 문제점, 제안 사항 등을 공유해야 한다.

그럴때마다 개발자들은 리드미에 위 내용들을 작성하고 공유할 수 있다.

 

마크다운 작성법

리드미는 주로 markdown이라는 언어로 작성된다.

확장명은 .md로 Readme.md와 같은 형식이다.

마크다운에서는 일반적인 텍스트를 입력할때와는 다른 문법을 가지고 있다.

 

1. 순서가 있는 목록 2. 순서가 있는 목록 3. 순서가 있는 목록 - 순서가 없는 목록 - 순서가 없는 목록   - 순서가 없는 목록
_기울인 글씨_ **굵은 글씨** **_기울인 굵은 글씨_**
# 1단계 제목 ## 2단계 제목 ### 3단계 제목 #### 4단계 제목 ##### 5단계 제목 ###### 6단계 제목
` 코드블럭 ` ``` 인용문 ```

 

이외에도 정말 많은 문법들이 존재하고 다양하게 활용할 수 있는데, 다음 링크들을 활용하면 좋을 것 같다!

https://www.markdownguide.org/basic-syntax/

Basic Syntax | Markdown Guide

https://namu.wiki/w/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4

마크다운