MyCloud

[GitHub] README.md 파일 작성하기 본문

Project/OpenSource

[GitHub] README.md 파일 작성하기

Swalloow 2016. 5. 20. 01:35



마크다운(Markdown) 이란?


Markdown은 텍스트 기반의 마크업 언어로 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능한 언어입니다.

최근 깔끔한 디자인으로 빠르게 작성할 수 있다는 장점으로 기술 블로그나 깃헙에서 많이 사용되고 있습니다.


그 중에서 GitHub의 Repository에 관한 요약 정보를 기록하는 

README.md 파일을 작성하는 법에 대해 알아보겠습니다.

보통 README.md 파일에 들어가는 내용은 다음과 같습니다.

(프로젝트 요약, 설치방법, 소스코드 설명, 이슈, 라이센스 정보)






마크다운 사용 문법


 1. 큰제목, 부제목

This is a H1

========


This is a H2

--------------


 2. 글머리

# This is a H1

## This is a H2

### This is a H3

#### This is a H4

##### This is a H5


 3. 들여쓰기

> This is a blockqute


 4. 순서없는 목록

* One

* Two

* Three


 5. 코드 블럭

<pre><code> This is a code block </code></pre>


 6. 이미지

![Alt text](/path/to/img.jpg)

![Alt text](http://swalloow.tistory.com/321451611/)




Comments