[ git & github ] Git Hub README.md 작성 | 마크다운 언어

 

 

이 포스팅은 구름 에듀 강좌의 "Git으로 시작하는 협업 및 오픈소스 프로젝트" 를 기반으로 작성되었습니다.

이 강의의 강사이신 "나동빈" 님의 자료임을 밝힙니다.

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

 

 

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

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

ndb796.tistory.com/

안경잡이개발자

 

 

 

---

 

 

@ README.md

 

 

README파일은 저장소의 이해를 돕기 위한 파일이다.

 

 

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

 

 

 

 

 

Add a README 버튼을 눌러보자.

 

 

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

 

 

 

 

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

 

README.md 파일을 확인할 수 있다.

 

 

 

 

 

 

 

 

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

 

 

 

내 로컬 디렉토리에도 README.md 파일이 생긴 것을 확인할 수 있다.

 

 

 

 

 

 

로컬에서도 파일 설정/수정이 가능하지만,

 

깃 허브에서 프리뷰를 통해 바로 보면서 설정 할 수 있기 때문에 github를 추천한다고 한다.

 

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

 

이제 README.md 파일을 작성해보자.

 

 

 

 

@ README.md 작성

 

 

1. 큰 글씨

 

큰 글씨는 # 으로 입력하면 된다.

 

# 이 한 개 있는 것이 가장 큰 글씨, 많아질수록 작아진다.

 

# 은 5개 까지 사용 가능하다고 한다.

 

 

2. 소스 코드

 

소스코드를 넣고 싶다면, ESC 키 밑의 백틱문자를 활용한다.

백틱문자 세개에, 사용하는 언어를 적으면 된다.

 

 

위 두가지를 믹스해서 작성해보도록 하겠다.

 

 

 

 

 

3. 링크 넣기

 

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

 

 

 

 

[ ]  사이에는 표시될 내용이,

( )  사이에는 링크로 들어갈 url 이 들어간다.

 

 

 

 

프리뷰를 이용해서 보면, 위와 같이 하이퍼링크 텍스트가 생성된다.

 

 

 

4. 순서없는 목록

 

 

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

 

 

 

 

 

 

* 뒤에는 공백이 있어야한다.

 

 

5. 인용 구문

 

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

 

 

 

 

 

 

프리뷰를 보면 아래와 같이 나온다.

 

 

 

 

 

6. 테이블 만들기

 

 

 

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

 

 

 

 

 

 

7. 강조 표시

 

 

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

 

 

 

 

 

 

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

 

 

 

 

깔끔하게 잘 나오는 것을 알 수 있다.

 

 

 

오픈소스 프로젝트의 가장 기본적인 "README"파일을

쉽게 이해할 수 있게 잘 써야 다른 사람들이 자신의 프로젝트가 무엇을 의미하는지 잘 파악할 수 있다.

 

 

때문에 README.md 파일을 잘 작성해주는게 좋을 것 같다.