🌿 중급 개발도구
README가 뭔가요?
쉽게 이해하기
새로 산 가전제품 상자를 열면 맨 위에 사용설명서가 있잖아요. README도 마찬가지로 프로젝트를 처음 보는 사람을 위한 첫 안내서예요. '이 프로젝트는 이런 거고, 이렇게 쓰면 돼요'라고 친절하게 알려주는 거죠.
핵심 정리
프로젝트 폴더에 있는 설명서로, 프로젝트가 뭔지, 어떻게 쓰는지 알려주는 문서예요.
자세히 알아보기
README는 프로젝트 폴더의 루트에 있는 README.md 파일이에요. GitHub에서 프로젝트를 열면 코드 목록 아래에 자동으로 표시되는 그 문서가 바로 README예요. 프로젝트가 무엇인지, 어떻게 설치하고 실행하는지, 어떤 기능이 있는지 설명하는 프로젝트의 얼굴이라고 할 수 있죠.
보통 마크다운(.md) 형식으로 작성해요. 제목, 설명, 설치 방법, 사용 예시, 라이선스, 기여 방법 같은 내용을 담아요. 예를 들어 'npm install로 설치하고, npm start로 실행하세요' 같은 실질적인 가이드가 들어가죠. 스크린샷이나 데모 링크를 넣으면 더욱 좋아요.
오픈소스 프로젝트에서는 README가 특히 중요해요. 코드를 처음 보는 사람이 5분 안에 '이게 뭐하는 건지, 나한테 필요한지, 어떻게 시작하는지'를 파악할 수 있어야 하거든요. README가 잘 쓰여있으면 프로젝트 사용자가 늘어나고, 기여자도 많아져요.
회사 프로젝트에서도 README는 필수예요. 새로 합류한 개발자가 환경 세팅을 혼자 할 수 있도록, API 문서 링크나 개발 서버 실행 방법을 README에 적어두면 온보딩 시간이 크게 줄어들어요. 잘 쓴 README 하나가 수십 번의 질문을 줄여주죠.