[TIL] GitHub README를 잘 적는 방법.

README란?

깃의 한 Repository를 간결하게 잘 보여주는 설명문 같은 것.

---

오늘 팀별 프로젝트 발표를 듣다가 튜터님께서 README를 써보라고 하셨는데 프로젝트에 대해서 어떻게 적어야 하는지, 어디까지 적어야 하는지, 무엇을 적어야 하는지 잘 몰랐기 때문에 튜터님께 직접 DM을 보내 여쭈어보았다. 튜터님은 README에 대해서 찾아보면 Format이 다양하게 나오는데, 어떤 README가 좋은 README인지는 잘 나오지 않는다고 하시며 예시를 들어 아주 자세하게 잘 가르쳐 주셨다. (아래 링크들은 튜터님이 참여하셨던 실제 프로젝트의 GIT의 Repo 주소)

앱, 백엔드, 프론트엔드에 따라 README를 적는 포맷이 조금씩 다르다.

---

앱(IOS)

https://github.com/3dollar-in-my-pocket/3dollars-in-my-pocket-ios

GitHub - 3dollar-in-my-pocket/3dollars-in-my-pocket-ios: [AppStore] 전국 붕어빵 지도 프로젝트 가슴속3천원

 

최상단에 귀여운 이미지가 들어가 있다. 이렇게 앱 같은 경우는이 프로젝트를 잘 보여주는 이미지를 넣어주면 좋다.

프로젝트 설명을 간결하게 해준다. 우리 프로젝트는 이런 이런 프로젝트에요!

프로젝트의 잘난 점을 얘기한다. 이 리포의 예시로는 구글 앱 스토어 1위를 해본 적도 있고, 여러 인터뷰를 하기도 했었다. 그 인터뷰에 대한 링크를 달아 놓았다.

---

백엔드

https://github.com/3dollar-in-my-pocket/3dollar-in-my-pocket-backend

GitHub - 3dollar-in-my-pocket/3dollar-in-my-pocket-backend: [AppStore, PlayStore] 전국 노점상, 푸드트럭 지도 "가슴

 

프로젝트가 어떤 프로젝트인지 이미지가 보이지 않는건 아쉽다.

가장 위에 보이는 Tests : 2169 runs : success는 2169번 돌리는 걸 다 성공했다는 뜻이다.

보면 실제 이용하는 사용자가 나오는데 사용자 수가 많을수록 구현하기 어렵기 때문에 이 부분은 백엔드에서 강조하기 좋다. 내가 기술력이 뛰어나다는 것을 보여주고 있다.

기술 스택을 써준다. 보면 이 기술도 쓰고 저 기술도 쓰고 나 혼자 서버 하나 이런거 말고 이렇게 복잡한 구조도 나 혼자 할 수 있어. 라는 느낌

마지막에 이메일 주소를 적어놓은 것도 아주 좋다. 연락 한 번 해볼까? 하는데 바로 이메일 있으면 아무래도 이메일을 바로 보낼 수 있기 때문에(디테일)

백엔드는 기술과 성과가 아주 중요하고 서비스에 대한 설명이 간략하게 있으면 좋고 자기소개가 들어간다.

---

프론트엔드

https://github.com/leejiwonn/floom

GitHub - leejiwonn/floom: FLOOM : 몰입 분위기 형성 웹 서비스

 

프론트엔드의 프로젝트인 경우는 아예 배포를 해서 방문할 수 있게끔 하는게 좋다. 직접 들어와서 보세요. 잘해놨어요! 하는 느낌으로.

다만 배포에 문제가 생겨서 못 볼수도 있기 때문에 페이지마다 캡쳐를 해두어서 올리는 것이 좋다. 프론트엔드는 페이지 디자인이 중요시되므로.

---

그 외 추가하면 좋은 점

내가 이러이러한 이슈가 있었습니다~ 하는 기술적 이슈 정리, 이 기술적 이슈를 해결한 거에 대한 설명은 다 README에서 하려 하지말고 블로그 링크로 달아놓는게 좋다.

채용하는 입장에서는 코드까지 안 보시는 분들도 있기 때문에 간결하게 쓰는 것이 좋다.

어떤 이슈가 있었고 그것을 어떻게 해결해냈는지, 아 이 사람은 이슈가 생겼을 때 이런 식으로 접근하는구나 하는 게 중요해서 이슈와 접근 과정, 해결 과정을 블로그에 정리하는 것이 매우매우 중요하다.

---

README는 마크다운으로 쓸 수 있는데 마크다운은 찾아보면 문법이 정리가 잘 되어 있으므로 한 번 찾아보면 된다. 아주!! 아주!!! 쉽다고 하셨다!

 

 

 

 

 

 

 

 

GitHub - 3dollar-in-my-pocket/3dollars-in-my-pocket-ios: [AppStore] 전국 붕어빵 지도 프로젝트 가슴속3천원

 

GitHub - 3dollar-in-my-pocket/3dollars-in-my-pocket-ios: [AppStore] 전국 붕어빵 지도 프로젝트 가슴속3천원

GitHub - 3dollar-in-my-pocket/3dollar-in-my-pocket-backend: [AppStore, PlayStore] 전국 노점상, 푸드트럭 지도 "가슴