#34 깃(Git) - 깃허브 리드미(README) 1 : 리드미 작성하기

안녕하세요 여러분! 에이블디입니다!

 

이번 시간에는 README(리드미) 작성하는 법에 대해 배워보려 해요!

 

공개된 깃허브 리포지토리는 전 세계 누구나 볼 수 있기 때문에 깃허브 활동을 많이 할수록 방문자도 늘어나겠죠?

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

그래서 많은 깃허브 사용자는 방문자가 편하게 자기 리포지토리를 살펴볼 수 있도록 안내문을 만들어 첫 화면에 띄워 두는데요,

이 안내문이 적혀있는 문서를 README 파일이라고 합니다.

 

그럼 README 파일을 작성해 볼까요?

 

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

마크다운에 대해서는 다른 시간에 풀어드리도록 할게요!

 

README 파일을 만들기 위해서 README 파일을 만들 깃허브의 리포지토리로 접속해주세요!

파일 목록 아래에 있는 'Add a README'를 누르면 README 새 파일을 만들 수 있습니다.

'Add a README' 버튼을 누르면 텍스트 편집기가 나오는데, 원하는 내용을 입력해 주시면 됩니다.

이때 줄을 바꾸려면 'Enter'키를 두 번 눌러서 빈 줄을 하나 넣어주어야 실제 화면에서 줄이 바뀌어 나타납니다.

README 파일 작성 화면에는 'Edit new file' 탭과 'Preview' 탭이 있습니다.

'Edit new file'에서 작성한 후 'Preview'를 눌러 결과 화면을 미리 확인할 수 있습니다.

Preview 화면을 확인하고 작성한 README 파일을 커밋해야 하는데요, 화면 아래에 README 파일을 커밋을 할 수 있도록 준비가 되어있습니다.

기본으로 들어 있는 커밋 메시지를 그대로 사용할 수 있고 직접 입력할 수도 있습니다.

저는 기본으로 작성된 커밋 메시지를 그대로 사용하겠습니다.

커밋 메시지를 작성하셨다면 'Commit new file' 버튼을 눌러 커밋해 주세요!

 

커밋을 하고 리포지토리 첫 화면으로 돌아오시면, 파일 목록에 README.md 파일이 생성되어있고 커밋 메시지도 적혀 있는 걸 볼 수 있습니다.

그리고 파일 목록 아래에 작성한 README 파일의 내용이 나타난 것을 확인할 수 있습니다.

 

이번엔 README 파일을 수정해 볼까요?

README 파일을 수정하려면 위의 이미지의 빨간 박스 안에 있는 README 내용 오른쪽에 있는 연필같이 생긴 아이콘을 눌러주세요!

 

README 파일을 수정한 후 'Preview' 탭을 눌러 Preview 화면으로 가시면 화면 오른쪽 위에 'Show diff'라는 체크박스가 있는데요, 체크박스를 누르면 미리 보기 화면에서 내용 왼쪽에 초록색 막대기와 빨간색 막대기가 표시가 됩니다.

초록색 막대가 나타난 부분은 추가된 내용이고, 빨간색 막대가 나타난 부분은 삭제된 내용입니다.

 

README 파일의 수정을 다 하셨다면 커밋 메시지를 작성하고 'Commit changes'를 눌러서 수정한 내용을 깃허브에 등록해 주세요!

파일 목록에 업데이트된 커밋 메시지와 함께 리드미 영역에도 수정된 리드미 내용을 확인할 수 있습니다!

 

이번 시간에는 리드미가 무엇인지 알아보고 리드미 작성까지 해 보았습니다.

 

다음 시간에는 리드미 파일을 좀더 전문적으로 작성할 수 있도록 마크다운 문법에 대해 알아볼게요!

 

그럼 여러분 다음시간에 만나요!