Git | 깃허브 README.md 과 .gitignore 설명

깃허브 리포지토리에 README.md 파일과 .gitignore 파일은 무엇인지 어떻게 작성하는지 간단하고 쉽게 설명드리겠습니다. 

 

 

목차

 

 

README.md 파일

 

소개

 README  파일은 안내문, 가이드라인 정도로 깃허브에서는 프로젝트에 대한 정보가 담겨 소프트웨어나 소스 배포시 포함되는 파일입니다.

 

 .md  라는 확장자는 Git에서만 사용되고 마크다운 문법을 사용하기 때문에 md 약자를 사용합니다.  마크다운(MarkDown)  언어는  마크업(MakeUp)  언어에서 파생되었지만 태그를 사용하지 않는 차이점이 있습니다.  

 

작성

파일을 작성하는데 정해진 양식은 없습니다. 일반적으로 아래와 같은 내용이 포함되니 참고 정도로 보시기 바랍니다.

• 프로젝트 - 구성, 프로그램 설치방법, 프로그램 사용법
• 저작권 및 사용권 정보
• 프로그래머 정보
• 버그 및 디버그
• 버전 및 업데이트

 

마크다운 (MarkDown) 문법 

1. 제목 -  #  의 개수로 제목의 크기를 조절할 수 있으며 H태그처럼 6단계까지 조절 가능합니다.

2. 줄바꿈 - 줄바꿈을 하려면 엔터를 두 번 눌러 공백줄을 만들어야 합니다.

3. 구분선 -  하이픈(-)  이나  별(*)  을 3개 이상 적으면 구분선으로 인식합니다.

4. 인덱싱 -  1.  을 작성하고 엔터를 치면 넘버링이 생성됩니다.

5. 불릿을 표현하려면  +  ,   -  ,   *  을 사용할 수 있습니다.

6. 덱스트 강조

• 강조 :  **  나  __  (언더바)
• 이탤릭 :  *  나  _  
• 취소선 :  ~~  로 텍스트 앞뒤를 감쌉니다.

7. 인용구 :  >  를 사용해 인용문을 작성합니다.  >>  사용하면 인용문 안에 인용문을 또 사용할 수도 있습니다.

8. 하이퍼링크 :

• 일반 하이퍼링크 :  <>  안에 링크 주소를 넣거나,  
• 이름이 지정된 하이퍼링크 :  []  안에 링크 이름을 넣고  ()  안에 링크 주소를 넣습니다.

9. 이미지 : 이미지 링크 주소나 깃허브 레파지토리에 이미지를 업로드해 사용할 수 있습니다. (Add files - Upload files)  

 

 

 

 

.gitignore 파일

 

소개

원격 저장소에 올리기 싫거나 올릴 필요가 없는 파일들을 명시하는 파일입니다. 파일이름만 적으면 해당 파일이름을 모두 제외시킵니다. 

 

문법

1.  *  - 와일드 카드 문자처럼 '/'를 제외한 모든 문자열과 매칭됩니다. 

*.js 		// 확장자가 .js인 모든 파일을 무시합니다.

 

2.  !  - !로 시작하는 패턴은 무시되지 않습니다. 

!hello.js 	// hello.js 파일은 무시되지 않습니다.

 

3.  /  - 경로로 시작하면 그 경로 안에 있는 파일만 무시됩니다.

/hello.js	// 현재 디렉토리의 hello.js만 무시됩니다.

 

4.  **  - 모든 경로를 의미합니다.

src/**/*.js	// src폴더의 모든 하위 경로의 모든 js파일을 무시합니다.

 

5.  {}  - {} 안에 있는 ,로 구분된 각각의 문자열들과 매칭합니다.

6.  []  - [] 안에 있는 첫문자-마지막문자 사이에 있는 모든 문자들에 대해 매칭합니다.  

 

관련포스트

Git | VScode 와 깃허브 (Github) 쉽게 연동하기

Git | 깃허브 (Github) 기초 용어 및 개념

Git | Git Bash로 Github 에 프로젝트 업로드

버전관리 | Github (깃허브) 사용법