10. Git에서 README.md 파일 작성해보기

상세 컨텐츠

본문 제목

10. Git에서 README.md 파일 작성해보기

프로그래밍 ( Programming )/깃허브 (GitHub)

by memyself 2021. 11. 22. 08:55

본문

README.md 파일은 소스코드에 앞서서 어떠한 목적으로 만들어진 Repository인가를 개략적으로 또는 구체적으로 보여주는 파일입니다.

예를 들어서 우리가 학교 또는 회사 그리고 팀을 이뤄서 소프트웨어 프로젝트를 진행한다고 할 때 우리가 한 것은 어떤 것이고 어떤 기술을 사용해서 이러한 결과를 만들었다는 설명을 오픈소스로 공개했을 때 이메일로 매번 답변할 수가 없기 때문에 누군가에게 정제된 내용을 보여주는 공간이기도 합니다. 때문에 리드미 파일을 잘 작성함으로써 프로젝트 소개를 위한 필요한 정보들을 빠르고 간단명료하게 제시할 수가 있게 됩니다. 

우리가 git과 github에서 많이 보는 파일로 Github에서 Repository를 만들때도 선택사항으로 만들 것인가 안 만들 것인가 옵션을 주기도 하는데 만약 안 만들 경우 만들면 다른 사람이 Repository를 볼 때 도움이 된다고 언급을 해주기도 합니다. 

README 파일은 디렉토리나 압축 파일에 포함된 기타 파일에 대한 정보를 가지고 있으면서 일반적인 소프트웨어 정보 또한 함께 배포됩니다. 또한 현재 git과 같은 저장소에서도 해당 파일을 default로 생성하여 해당 저장소의 설명을 기입할 수가 있습니다.

 

포함되는 정보들 중에서 대표적인 정보 리스트이며 한개이상을 포함합니다.

  1. 컴퓨터 구성 안내
  2. 설치 안내
  3. 사용법
  4. 파일 메니페스트 (파일 목록 포함)
  5. 저작권 및 사용권 정보
  6. 배포자 및 프로그래머의 연락처 정보
  7. 알려진 버그
  8. 트러블 슈팅
  9. 크레딧
  10. 체인지 로그

 

위에 나열한 목록 이외에도 오픈 소스 배포판을 위해서 일반적으로 다음의 항목들을 포함할 수도 있습니다. 

  1. AUTHORS: 제작 정보
  2. THANKS: 도와주신 분들에 대한 정보
  3. ChangeLog: 프로그래머들이 참고할 수 있는 자세한 체인지 로그
  4. NEWS: 사용자들이 참고 가능한 기본적인 변경 로그
  5. INSTALL: 설치 안내
  6. COPYING/LICENSE: 저작권 및 사용권 정보
  7. BUGS: 알려진 버그 및 새로운 버그 보고 방법 안내 

 

리드미 작성법

우선 우리가 보는 README파일에서. md라는 확장자가 붙어있습니다. md는 markdown이라는 약자입니다.

마크다운 (Markdown)은 일종의 마크업 언어로 텍스트에 태그를 이용해서 글자를 굵게 하거나, 이미지를 삽입하는 등의 다양한 기능을 지원합니다. 마크다운은 웹상에서 글을 쓰는 모든 사람들을 위한 글쓰기 도구 (서식, 포맷, 양식)입니다. 마크다운뿐만 아니라 txt 등의 다양한 형식 또한 지원합니다.  

작성을 위한 공간은 Github에서 실행이 가능합니다. 작성된 파일은 옆에 Preview 버튼을 눌러보면서 결과에 대해 미리 확인이 가능합니다. 

 

1. 제목 

# 을 하나 사용하면 <H1> 태그이며 2개 사용하면 <H2> 태그가 됩니다. #은 총 6개까지 사용 가능하며 늘어날 때마다 글씨가 작아지게 되니다. 

# 제목
## 부제목
### 소제목

 

2. 소스코드 블록 

소스코드를 삽입하고 싶을 때는 숫자 1 버튼 왼쪽의 ` 기호를 사용하여 넣을 수가 있습니다. ``` 후에는 반드시 자신이 넣고자 하는 코드의 언어 종류를 명시해야 하는데 저는 c언어를 넣기 위해 c를 ```옆에다가 기입해주었습니다. 

```c
#include <stdio.h>

int main(void) {
	printf("Hello world");
	return 0;
}
```

 

 

3. 링크 삽입

텍스트에 링크를 삽입하기 위해서는 대괄호[ ]를 이용하여 README파일에서 보이는 이름을 기입하셔야 하며 그리고 실제 링크는 소괄호( )를 이용하여 대괄호 바로 옆에 기입을 해주시면 다음과 같이 음악 주소라는 글자에 마우스 클릭이 활성화되면서 특정 링크로 넘어가게 됩니다.

코드

 

 

4. 순서 없는 목록

작성을 위해서 *를 이용하시면 됩니다

* 깃 튜토리얼 
	* 깃 Clone
	* 깃 Pull
	* 깃 commit
		* 깃 commit 1

 

 

5. 인용 구문 작성하기

작성을 위해서 >과 ' '를 적절하게 이용하시면 됩니다. 

> '꾸준하게.' - CHJ -

 

6. 테이블 작성

이름|영어|정보|수학
---|---|---|---|
김|99점|90점|100점|
이|91점|95점|100점|
최|94점|97점|100점|

 

7. 강조 및 취소 구문 작성

강조를 위해서는 **내용**과 같이 2개의 별표 사이에 강조하고 싶은 내용을 넣으면 되며 취소선을 표시하고 싶을 때는
~~ 내용~~ 과 같이 2개의 물결 표시 사이에 내용이 들어가게 작성해주면 됩니다. 

 

 

추가 내용

마크다운의 장단점

장점

  • 읽기 쉽다 (마크다운은 다른 마크업 언어에 비해서 훨씬 알아보기가 쉽습니다. 제목은 앞에 #을 붙여주면 되며, 글자를 강조하기 위해서 주위에 **으로 감싸주면 됩니다. HTML에 비해서 마크다운으로 작성된 텍스트는 실제 브라우저에서 어떻게 보일지에 대해서 쉽게 상상이 가능합니다)
  • 익히기 쉽다 (마크다운은 상당히 간단합니다. 사람들이 많이 사용하는 기능을 마크다운으로 썼으며, 복잡한 것은 HTML로 쓰도록 디자인되었습니다. 때문에 몇 가지 제한은 있으나 중간에 HTML을 써도 상관이 없습니다)
  • 모바일 친화적 (모바일 보급이 활성화되면서 글을 쓰고 올리는 경우가 상당이 많아졌습니다. 그러나 모바일로 서식이 들어간 글을 쓸 때 에디터 에러나 작은 화면으로 인한 작성 문제가 존재하는데 마크다운을 이용하여 글을 쓰면 간단한 태그만으로도 쉽게 서식을 넣을 수 있기에 작성이 편합니다)

단점

  • 문법이 너무 단순 (문법이 너무 단순하여 기능을 벗어나기 위해서 결국 HTML을 사용해야 합니다. 대표적으로 마크다운에서는 이미지를 정렬하는 문법이 없기에 HTML의 img 태그를 이용해야 합니다)
  • 확장 문법이 많음 (첫 번째 단점으로 인하여 발생한 문제이며 문법이 너무 단순하기에 불편함을 해소하기 위해서 여러 확장 문법들이 발생하였고 이러한 문법들이 파편화되어 퍼져있기 때문에 어느 문법은 다른 플랫폼에서는 작동을 안 하는 문제들이 존재합니다)
  • 멀티미디어 삽입이 불편함 (보통 이미지 업로드를 위해서 업로드 버튼을 이용하지만 마크다운은 그저 텍스트만 가능하기에 이미지 삽입과 업로드 및 주소를 따오는 과정들이 모두 분리되어 있습니다)
728x90
반응형

태그

관련글 더보기

댓글 영역