[GitLab#5] MARKDOWN을 이용한 README.md 작성하기(기초와 문법)

MARKDOWN?

텍스트 기반의 마크업언어로 2004년 만들어졌다.(존그루버) 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다. 무엇보다 문서를 빠르게 작성이 가능하고 직관적으로 인식할 수 있다. MARKDOWN이 사용된 이유는 github.com 덕분이며 나도 마찬가지이지만 GitHub 사용자는 관련 소스 또는 소프트웨어를 사용하기전에 무조건 README.md를 먼저 읽어보고 이런 부분이 유용하게 인식되어 여러부분으로 사용된다.

• 장점
  - 간결하다.
  - 별도의 도구없이 작성가능하다.
  - 다양한 형태로 변환이 가능하다.
  - 텍스트(text)로 작성되기 때문에 용량이 작다
  - 버전관리시스템을 이용하여 변경이력을 관리할 수 있다.
  - 지원하는 프로그램과 플랫폼이 다양하다.

• 단점
  - 표준이 없다.
  - 표준이 없어서 생성물이나 변환방식이 다를 수 있다.
  - 모든 HTML 마크업을 대신할 수 없다.

README.md?

디렉토리나 압축 파일에 포함된 기타 파일에 대한 정보를 포함하여 소프트웨어와 함께 배포되는데 흔히 개발자 입장에서는 Git에서 많이 볼 수 있다.

프로젝트가 어떠한 목적으로 개발되었으며 목표와 코드의 개요나 구조도 등을 상세하게 사용자에게 노출시킴으로서, 사용자가 프로젝트 또는 소프트웨어를 사용함에 있어서 유용하도록 설명하는 부분이다.

README 파일 확장자는 txt,md,1st,doc Read.me등 다양한 파일명과 확장자의 형태로 작성된다.

• 설치하려는 클라이언트의 필수조건 (Prerequisites)

• 설치 방법 (Installation Process)

• 사용방법 (Getting Started)

• 저작권 및 사용권 정보 (Copyright / End User License)

• 배포자 및 개발자의 연락처 정보 (Contact Information)

• 알려진 버그 (Known Issues)

• 문제 발생에 대한 해결책 (Troubleshooting)

• 크레딧 (Credit)

• 업데이트 정보 (Change Log)

오픈소스를 기반으로한 경우 다음과 같이 README 파일들을 포함해야한다.

• README : 일반 정보

• AUTHORS : 제작 정보

• THANKS : 도와주신 분들에 대한 정보

• ChangeLog : 개발자들이 참고 할 수 있는 자세한 업데이트 정보

• NEWS : 사용자들이 참고 할 수 있는 자세한 업데이트 정보

• COPYING / LICENSE :  저작권 및 사용권 정보

• BUGS : 알려진 오류 및 새로운 오류 보고 방법 안내

기본문법

<!--  #Title  -->

#Title(Product name)

<h1>Title(Product name)</h1>

##Title(Product name)

<h2>Title(Product name)</h2>

###Title(Product name)

<h3>Title(Product name)</h3>

####Title(Product name)

<h4>Title(Product name)</h4>

#####Title(Product name)

<h5>Title(Product name)</h5>

######Title(Product name)

<h6>Title(Product name)</h6>

<!--  #수평선 -->

___

***

---

<!-- #텍스트 출력 -->

<p>텍스트 출력하기</p>

<!--  #텍스트 강조 -->

*single asterisks* - 기울임체

_single underscores_ - 기울임체

**double asterisks** - 굵은글씨체

__double underscores__ - 기울임체/굵은글씨체

***triple underscores*** - 기울임체/굵은글씨체

~~cancelline~~ - 취소줄

<!--  #인용 -->

>인용

>>인용

>>>인용

<!--  #목록 -->

* 리스트1

+ 리스트2

+ 리스트3

 * 서브 리스트

 * 서브 리스트

-리스트4

 1.순차리스트1

 2.순차리스트2

 

<!--  코드블록  -->

Objective-C에서는 `NSString *str = @"test"` 선언하였습니다.

```

#tcpdump -i any host 8.8.8.8

```

<!--  테이블 -->

| 이름 | 설명 | 나이 |

| ----| ---- | -- |

| Mike| father  | 40 |

| Jane  | mom | 30 |

| me  | son | 2  |

<!--  테이블 정렬   -->

| 이름   | 설명 | 나이 |

| ---:  | :--- | :--: |

| Mike  | father  | 40 |

| Jane  | mom | 30 |

| me  | son | 2  |

<!--  링크 -->

* T Story : [Lunightstory](http://lunightstory.tistory.com/)

<!--  참고링크 -->

[티스토리][1]

[1]:http://lunightstory.tistory.com/

주소만 링크하는경우

<a href = "http://lunightstory.tistory.com/">http://lunightstory.tistory.com/

<!--  이미지 -->

<!--  -->


<!--  타이틀을 포함하는 이미지   -->


<!--  각주 -->

본문이나 설명을 보충하기위함

스위프트는 애플의 iOS와 macOS를 위한 프로그래밍 언어로 2014년 WWDC에서 처음으로 소개되었다.[^swift]

[^swift]: 애플세계개발자컨퍼런스

<!-- 네임드 앵커   -->

특정 페이지를 점프하는 용도로 사용

### 자주가는 페이지

 *[1.서론](#chapter-1)

 *[2.본론](#chapter-2)

 *[3.결론](#chapter-3)

 

 ##### 1.서론 <a id="chapter-1"></a>

 서론은.......

 ##### 1.본론 <a id="chapter-2"></a>

 본론은.......

 ##### 1.결론 <a id="chapter-3"></a>

 결론은.......

ATOM을 이용한 테스트 결과