Github 저장소 소개글 README 작성하는 방법

깃허브 저장소 아래에 보면 다른 사람이 이 저장소에 대한 이해를 돕기 위해 README라는 것을 추가하라는 박스가 나옵니다. 

 

쉽게 생각하면 저장소 소개글인데요, 오늘은 간단하게 README 작성 방법에 대해서 알아보겠습니다.

 

 

Add a README를 클릭 후 Preview로 가서 Commit new file에 Create README.md 라고 입력해 리드미 파일을 생성해 주세요.

 

 

아래쪽에 리드미 파일이 생긴것 보이지요?

 

 

그럼 다시 리드미 파일로 들어가서 어떻게 수정하는지 알아볼께요.

 

우선 제목부분은 #, ##, ###, ####, #####, ######으로 샾 6개까지 가능하며, 순차적으로 크기가 작아져요.

HTML에서 제목 태그에 h1이 제일 크고, h6가 제일 작은것과 동일한 원리라고 생각하면 됩니다. 

 

아래는 출력한 결과인데요, #샾 1개는 너무 커서 일반적으로 ##으로 많이 사용합니다.

 

소스코드 블록은 ESC 키 아래, 숫자 1왼쪽에 있는 ~물결키를 ```세 번 누른후, 사용하는 언어타입을 명시하면 됩니다.

 

하이퍼링크랑 인용구문은 아래와 같이 적으면 되는데요, 링크 걸때 대괄호[]와 소괄호()사이에 사이띄기가 없어야 해요!

 

 

작성할때는 번거롭지만, 표도 만들 수 있구요ㅎㅎ

 

 

순서가 없는 리스트는 *별표를 이용해서 만들 수 있어요! 여기서는 사이띄기 꼭 해줘야 한답니다^^

 

 

자아 그럼 Preview에서 Update README.md로 커밋해 리드미 파일을 업데이트 할 수 있어요.

 

저장소에 들어가면 소개글이 이렇게 나온답니다. 제 소개글은 포스팅용이어서 엉망^^;;

 

아참, 아래에서 목요일의 강조구문은 '오늘은 **목요일** 입니다'로,

다이어트의 취소선은 '~~다이어트는~~ 안 할래요'로 표기할 수 있답니다.

 

리드미 파일은 프로젝트를 본격적으로 시작하면 다른 사람들이 보기 쉽게 알기 위해 꼭 잘 작성해야겠쥬?