깃헙 리드미(.Readme)엔 뭐가 들어가야할까?

개발자라면 마크다운을 통해 리드미를 작성해보았거나, 다른 사람이 작성한 리드미를 본 적이 있다.
프로젝트 자체를 잘 끝내는 것도 중요하지만 진짜 끝! 이라고 하기위해선 해당 프로젝트를 남들이 볼 수 있게 요약본을 잘 작성하는 것도 중요하다.
여기서 해당 프로젝트가 무엇이고 어떻게 사용하는지를 소개하는 글이 리드미다.

 

목차 그렇다면 리드미를 왜쓰는 걸까? 그래서 어떻게 써야 잘쓴걸까? 활용 예시

 

 

---

리드미를 왜 써야할까?

우선은 리드미는 프로젝트의 첫 인상에 큰 영향을 준다. 깔끔하고 정보가 잘 정리된 리드미는 프로젝트에 대한 신뢰감을 주며 관심을 끌 수 있다.

이게 가장 중요한건데, 리드미는 결국 개발자의 포트폴리오다.
개발자는 이력서를 제출하는 것 만큼이나 포트폴리오가 중요한다. 이때 잘 작성한 리드미는 프로젝트 코드가 어떤지와는 별개로 전문적이라는 인상을 줄 수 있다.
내가 면접관이었어도.. 아무리 잘 쓴 코드여도 리드미가 따로 적혀져있지않으면 코드를 까볼 생각조차 안 들 것같다.

이건 조금 이타적인 얘기인데 결국 다른 유저들이 내 프로젝트를 보고 참고하거나 활용하고자할때 어떻게 활용해야할지 알려줄 수 있기 때문이다.
깔끔하게 정리된 리드미는 다른 개발자들이 해당 프로젝트를 참고하거나 활용할 때 큰 도움이 된다. 
예를 들어 내가 테트리스 프로그램을 작성했고 다른 유저가 참고 자료로 내 프로젝트를 다운로드 받아 활용하려고 할때
환경설정이나 사용하기 위해 주의해야할 점을 따로 작성해놓지 않으면 다른 유저가 사용할때 불편함을 겪을 수 있다.
이때 설치 방법, 사용법, 주의 사항 등을 명확히 작성해두면 다른 사용자들의 시간을 절약해줄 수 있다.

 

그래서 어떻게 써야 잘쓴걸까?

그래서 어떻게 해야 리드미를 잘썼다고 할 수 있을까?
물론 리드미를 작성하는데엔 여러 포맷이 있지만 보편적으로는 프로젝트의 무엇을, 왜, 어떻게에 대해 작성하는 것이 좋다.

 

• 무엇을 만들었는지
  프로젝트의 주요 목적과 기능을 명확하게 소개하기
• 왜 이걸 만들었는지
  프로젝트의 동기나 배경에 대한 설명을 추가하기
• 어떻게 만들었는지
  사용한 기술 스택, 라이브러리, 툴 등의 정보를 작성하기
• 트러블 슈팅
  프로젝트를 진행하면서 발생했던 문제와 그 해결 과정을 작성하기

위의 내용은 프로젝트 개요를 위한 작성이며 이것과 별개로 다른 사용자들이 우리 프로젝트에 쉽게 접근하기 위해서는

 

• 목차
• 프로젝트 설치 및 실행방법
• 프로젝트 사용방법(다른 사람들이 풀리퀘를 올려 기여하는 방법 등)
• 참여한 팀원
• 라이센스

등도 같이 작성해주는 것이 좋다.

 

활용 예시

 

자기 PR의 시대이다보니 리드미가 비단 프로젝트의 설명으로 쓰이는 것 외에도 본인의 프로필을 한눈에 정리하기 위해 사용하는 경우도 있다.

이건 내 프로필이다ㅎㅎ

 

딱 마침 최근에 마무리된 프로젝트가 있어서 적용해보고자 한다.. (아직 적용 못했다)

https://github.com/Underline-r/BE-underline/blob/main/README.md

 

---

참조한 글

 

https://www.freecodecamp.org/korean/news/gisheobeu-peurojegteue-rideumi-paileul-jal-jagseonghaneun-bangbeob/

깃허브 프로젝트에 리드미 파일을 잘 작성하는 방법