리드미 파일은 왜 쓸까?

코드는 쓰는 것 보다 읽는 게 중요하다.

최근 무분별하게 리포지토리를 생성했다. 쌓여가는 프로젝트를 보며, 내가 다시 코드를 볼때 '이게 무슨 소리더라?' 하는 상황이 자주 생기곤 했다.

코드를 통해 작업을 표현하기는 쉽지만, 왜 이 코드를 작성했는지, 수정했다면 왜 그랬는지에 대한 답변이 전혀 담기지 않았다.

기계와 대화할 순 있는데, 리드미가 없으면 사람이랑 일하긴 어려운 셈이다.

다시말해,, 코드는 행동을 보여주면, 리드미는 행동의 이유가 되는 것!

리드미는 이 이유를 상기시켜주기 위해 작성하는 듯 하다고 느꼈다.

언제, 어디서나, 누군가가 본다 하더라도 내 행동에 대한 근거를 리드미가 정리해주는 셈이다.

리드미 101의 설명에 따르면 "리드미는 프로젝트 소개와 설명을 담은 텍스트 파일"이라고 한다.

아래에선 리드미를 작성할 때 초보자가 참고하기 좋은 내용이라 들고왔다.

예시로 네이버의 리드미를 참고해서 보면 좋을 듯 하다.

누구든지 '알' 수 있게

볼 수 있지만 이해하지 못하는 글은 난해함만 불러온다.
최대한 쉽게 쓰고 누가 읽어도 이해할 수 있게 작성하는 습관이 필요하다.

가독성 살리기 == md 문법 배우기

md 문법을 활용해 문단을 구분하고 복문을 줄이자.
심오한 말을 줄이고 간결하게 쓰는 것이 필요하다.

결론 : 많이 써보자