이번 포스팅에서는 여러분들의 Github Repository를 한층 업그레이드 시킬 수 있는 Readme.md 파일 작성법에 대해서 알아보겠습니다.
README 파일은 주로 Github 프로필 혹은 Repository에 대한 설명을 나타내기 위해 작성한다. README는 쉽게 말하면 가이드라인, 안내문 정도로 생각할 수 있다. 그 이유는 README 파일에는 일반적으로 프로젝트에 대한 정보가 담겨 있어, 소프트웨어 배포시에 함께 포함되는데, 이러한 점이 마치 새 제품을 샀을 때 읽어보는 사용 설명서와 비슷하기 때문이다.
우리가 흔히 Readme.md라고 말하는 .md라는 확장자는 Git에서만 사용하는 것이고, Windows 또는 Mac OS에서는 .txt를 확장자로 사용한다. 여기서 md는 마크다운의 약자로 마크다운 문법을 사용한다는 의미이다. 이전에 Issue 템플릿을 작성할 때 사용한 언어가 바로 마크다운 언어인데, README 파일을 작성할 때에도 이 마크다운 언어를 사용한다. 사실 멀리갈 것도 없이 벨로그에서 작성하는 파일도 마크다운 언어 형식을 따르고 있다.
※ MarkUp Language & MarkDown Language
마크업 언어란, 문서가 화면에 표시되는 형식을 나타내거나 데이터의 논리적인 구조를 명시하기 위한 규칙들을 정의하는 언어이다. 즉, 어떤 데이터에 대해 가공이나 연산 작업을 수행하는 것이 아니라 그저 데이터를 화면에 표시하기 위해 사용하는 언어라는 뜻이다. 이러한 점에서 프로그래밍 언어와 차이점을 보인다. "HTML은 프로그래밍 언어가 아니다"라는 이야기가 나오는 것도 이러한 이유에서이다.
마크다운 언어는 마크업 언어에서 파생되었지만, 태그를 사용하지 않는다는 점에서 차이가 있다. 읽고 쓰기 쉬운 문서 양식을 지향하기 때문에 간단한 문법만 숙지하면 누구나 쉽게 작성할 수 있다.
README 파일을 작성해야 하는 이유는 무엇일까? 3가지의 이유로 간단하게 정리해보았다.
① For Myself
② For My Co-workers
③ For Users
README 파일을 작성하는 방법에 있어 정해진 양식은 하나도 없다. 어떤 구성요소를 포함할지 모르겠다면 아래의 내용을 고려해볼 수 있다.
위와 같이 너무 딱딱한 형식이 싫다면, 프로젝트 소개, 개발 기간, 개발자 소개(역할분담 상세), 개발환경, 기술스택, 주요기능, 프로젝트 아키텍쳐 등을 포함하여 작성할 수도 있다.
확장자 역시 정해져있는 것은 아니고 다양한 형식을 사용할 수 있다. 다만, 일반적으로 .md 확장자를 사용할 것을 권장한다.
README 파일을 작성하려면 마크다운 문법은 필수로 알아야한다. 하지만, 위에서 설명한 것처럼 마크다운 문법은 매우 쉽기 때문에 한번만 보고도 바로 숙지할 수 있을 것이다.
① 제목
#
의 개수로 제목의 크기를 조절할 수 있다. #
이 많아질수록 작아진다.② 줄바꿈
③ 구분선
하이픈(-)
또는 별(*)
을 사용할 수 있다. ④ 인덱싱
1.
을 작성하고 엔터를 치면 순차적으로 번호가 자동생성된다.⑤ 불릿
+, -, *
을 사용한다.⑥ 텍스트 강조
**
또는 __
로 텍스트의 앞뒤를 감싼다.*
또는 _
로 텍스트의 앞뒤를 감싼다. ***
또는 ___
로 텍스트의 앞뒤를 감싼다.~~
로 텍스트의 앞뒤를 감싼다.⑦ 인용구
>
를 사용하여 인용문을 작성할 수 있다. >>
를 사용하여 인용문 안에 인용문을 추가로 작성할 수도 있다.⑧ 하이퍼링크
<>
안에 링크 주소를 넣는다.[]
안에 링크의 이름을 넣고 ()
안에 링크 주소를 넣는다.()
안에 링크 주소와 부연설명을 콤마로 구분하여 넣는다. (여기서 부연 설명이란, 하이퍼링크에 커서를 가져다 대었을 때 보이는 툴팁을 말한다.)⑨ 이미지
![이미지 이름](복사한 링크 주소)
방식으로 작성하면 이미지 첨부가 완료된다.① README 파일을 작성할 Repository로 이동한 후 아래에 보이는 Add a README 버튼을 클릭한다.
② Edit 모드에서는 마크다운 문법으로 작성된 글이 보이고, Preview 모드에서는 미리보기 형식의 파일이 보인다.
③ 아래와 같이 Edit 모드에 글을 작성하면, Readme.md 파일이 완성된다.
④ 아래의 링크에서 완성된 모습을 확인할 수 있다.
>> 깃허브 링크
[이미지 출처]
덕분에 좋은 정보 얻어갑니다, 감사합니다.