공개된 깃허브 저장소는 전 세계 누구나 볼 수 있기 때문에, 활동을 할수록 방문하는 사람이 늘어날 것이다.

하지만, 프로필과 컨트리뷰션 그래프만 살펴보는 것으로는, 그 저장소의 주인이 어떤 활동을 했는지 구체적으로 알기 어렵다.

그래서, 많은 깃허브 사용자는 방문자가 편하게 자기 저장소를 살펴볼 수 있도록 안내문을 만들어 첫 화면에 띄운다. 이러한 문서를 README 파일이라고 한다. 지금까지는 커밋하는 방법만 알아봤기 때문에, README.md 부분은 비워져있을 것이다. 작성하는 법에 대해서 알아보자.

README 파일 만들기

우선, 어떻게 README 파일을 활용하고 있는지, 확인해보자.

README 파일은 마크다운(markdown)문법을 사용하기 때문에, 확장자는 .md를 사용한다.

kyrieko/html5-book-9

에 접속해보자!

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/78d86ba4-b671-45e9-b5f8-6833a090fc0c/Untitled.png

이런 식으로, 해당 파일을 설명해주는 것을 볼 수 있다.

이미지나 외부 링크도 넣을 수 있다.

  1. 하단에, "Add a README"를 누른다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/d8e9ea74-6a23-4e9e-b320-dc47734f4474/Untitled.png

  1. 텍스트 편집기를 이용해서 내용을 입력한다.

줄을 바꾸려면, 'Enter'키를 두번 눌러서 가운데 줄을 비워야한다. 그래야 실제로 줄일 바뀌어 나타난다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/70f92901-4aa8-487e-b6a1-6e39a38c2941/Untitled.png