Git에서 소개글(README.md)파일 작성하기 | Git README.md | 깃 소개 파일

모든 포스팅은 구름에듀 강좌 중 "Git으로 시작하는 협업 및 오픈소스 프로젝트" 의 내용을 담고 있으며

출처는 아래의 주소로 "나동빈"님의 자료입니다. 

상업적인 의도가 아닌 공부한 것을 정리해놓는 목적으로 포스팅 한 것입니다.

edu.goorm.io/learn/lecture/11528/git으로-시작하는-협업-및-오픈소스-프로젝트/info

구름EDU - 모두를 위한 맞춤형 IT교육

 

---

# Git 소개글

 

README파일은 다른 사람이 이 저장소에 대해서 이해하는 것을 돕기위해 쓰는 파일을 말한다.

간단하게 깃허브에서 파일을. 추가할 수도 있다.

실제로 Edit new file안에 작성된 파일을 Preview에서 바로 확인할 수도 있다.

 

입력 후 일단 Commit new file을 클릭하여 만들어 보자.

 

바로 소개 글 형태로 생긴다.

README.md파일은 깃허브 내에서 수정해주는 방법이 매우 편리하다.

 

 

자신의 로컬 저장소에도 같은 내용을 담고 싶다면 git pull 명령어를 통해 받아주면 된다. 동일한 내용이 출력된다.

 

로컬에서도 파일 설정/수정이 가능하지만 깃 허브에서 프리뷰를 통해 바로 보면서 설정 할 수 있기 때문에 github를 추천한다.

 

README파일은 마크다운의 확장자인 .md를 가진다는 특징이 있다.

ko.wikipedia.org/wiki/마크다운

마크다운 - 위키백과, 우리 모두의 백과사전

 

문법을 알아보기 위해 간단한 코드를 작성해보자.

 

위와 같이 코드를 작성한 후 preview를 통해 확인해보면 백틱 문자 안에 있던 코드가 정상적으로 처리된 것을 확인 할 수 있다.

 

 

링크를 넣고 싶다면 다음과 같이 작성하면 된다.

 

 

작성을 완료하면 아래와 같이 클릭 시 링크로 이동할 수 있게끔 만들어 진다.

 

* 은 순서 없는 목록을 나타낸다.

 

 

인용구문은 다음과 같이 작성한다.

 

테이블은 다음과 같이 작성한다.

 

강조는 다음과 같이 할 수 있다.

 

여기까지 실습을 해보았다면, 저장을 해주면 된다.

 

 

오픈소스 프로젝트의 가장 기본적인 "README"파일을 쉽게 이해할 수 있게 잘 써야 다른 사람들이 자신의 프로젝트가 무엇을 의미하는지 잘 파악할 수 있다.