첫 Readme 작성

eod940·2021년 12월 29일
0

오늘은 cv를 작성하며 내 깃헙(github/eod940)에 리드미 파일을 업데이트 했다. 사실 프로젝트를 진행할 때 readme 파일을 만질 생각을 안했다...
귀찮기도 하고 아무도 안볼 거라는 생각에 건들지도 않았다.

그렇지만 cv를 작성하며 나의 아주 작고 빈약한 이력들을 보며 생각이 바뀌었다. 설령 작은 프로젝트일지언정 어떤 생각을 가지고 만들었는지, 왜 만들었는지와 같이 프로젝트의 목적이 내 기술 역량 성장에 아주 큰 도움이 된다는 것을 깨달았다.

또한 내가 프로젝트를 진행하고 결과물을 냈다면 필연적으로 결과물을 누군가가 볼 것이다. 당연히 무슨 프로젝트인지 잘 정리해서 보여줘야 그들이 관심을 보일것이다.

그래서 난 이 깨달음들을 바탕으로 onedeal 프로젝트 내용을 열심히 정리했다. 내가 정리하며 중점으로 두었던 내용은 다음과 같다.

  • 이 프로젝트를 왜 했는가?
  • 다른 프로젝트와의 공통점과 차이점이 무엇인가?
  • 누가 이 내용을 볼 것인가?

나는 위 질문들에 답을 하며 readme 내용을 읽어주는 사람이 더욱 편안하게 읽었으면 좋겠다는 마음으로(마치 교수님께 레포트를 제출하듯..) 열심히 작성했다.

사실 열심히 작성한다고 했지만 개발자로서 이 프로젝트는 너무 빈약하다고 생각했다. 하지만 괜찮다. 나는 프로젝트를 꾸준히 할 것이고 이렇게 하다보면 점차 성장해 나갈 것이라 다짐한다.

readme의 자세한 내용은 github.com/eod940/onedeal에서 볼 수 있다.

profile
https://eod940.tistory.com

0개의 댓글