번외 - ① : git readme 작성
목차
- 시작하며
- 도움을 받은 곳들
- 나의 github
- 내가 작성한 README.md 둘러보기
- 마치며
시작하며
프로젝트를 진행하면서 github에 push 하고 다른 환경에서 pull 해서 사용해보는 작업을 반복하면서 지내던 어느 날, 유튜브를 시청하는데 어떤 시니어 개발자님이 멘토링을 컨셉으로 시청자들의 github를 봐주고 있는 영상을 발견했다.
흥미로운 마음(?)에 잠깐 시청하려고 들어갔는데 스트리머님(시니어 개발자님)이 이런 말을 하셨다.
기술 블로그에 예쁘게 꾸미거나 노션을 활용하여 설명을 해도 좋지만,
깃허브 Readme 파일에 간략하게라도 설명글을 써주는게 좋다!
해당 영상을 시청할 때까지는 별 감흥이 없었는데, 반복되는 Push • Pull • Commit 속에서 이런 생각을 했다.
토이 프로젝트는 실력 향상이나 스펙을 만들어주는 개발자의 필수 요소인데,
나의 깃허브를 정말 스펙처럼 어필하려면 단순히 Push, Pull 혹은 잔디심기로는 부족한 듯 하다.
그래서 이런 지나가는 말이라도 적극 수용하여 나의 깃허브를 그럴싸하게 보이게 하기 위해 Readme 파일을 만들기로 다짐했다.
도움을 받은 곳들
사실 Readme 파일을 작성하기로 다짐은 했지만 난생처음 하는 Readme 작성이었기에 어떤 형식으로 작성해야 하는지, 어떻게 작성해야 좋은 Readme 파일이라고 할 수 있을지 고민하면서 구글링을 했다.
그러는 와중에 어떤 내용을 작성하는지, 어떤 Readme가 좋은 Readme인지 잘 설명해주신 블로그를 발견하여 배웠고, 또 예제를 올려주셔서 예제를 보며 차근차근 따라 하고 있다.
[Github 알아보기] 좋은 Readme 작성하기
Github 레포지터리를 들어가면 가장 먼저 볼 수 있는 것이 Readme.md이다. 내 프로젝트를 잘 알리고, 사람들이 유입되어 활성화 시키기 위해선 좋은 Readme를 작성하여야 한다. Readme를 작성할때 포함하
alwaysone.tistory.com
나의 github
오늘도 평화로운 나의 깃허브 메인화면이다.
레포지토리가 네 개나 있지만 그중 이름에 BoostCourse가 들어간 두 개의 레포지토리는 전 회사를 다닐 때 Java, JSP를 해결하기 위해 과제용으로 만든 레포지토리이고, 나머지 하나는 노마드 코더님의 Javascript 강의를 들으며 모멘텀 클론 코딩을 수료하는 과정에서 만든 레포지토리이다.
고로 Behind를 최초의 토이 프로젝트로 진행시키고 있다 ^^
이전 직장을 그만두면서 본격적으로 토이 프로젝트를 설계(거의 기획에 가까운..)하고 6월 25일부터 1일 1 잔디 운동을 진행하고 있다.
사실 중간에 2개는 주말에 휴식을 엄청나게 취하다가 Push를 못해서 비어있는데, 서로 다른 날이지만 주말도 없이 프로젝트에 전념해야 하는데 Push를 까먹은 것이 부끄러울 따름이다..!
전형적인 자바 기반 백엔드 개발자의 언어 퍼센트라고 생각한다.
아마 시간이 더 지나서 다양한 언어를 능숙하게 다루게 되면 압도적인 지위를 갖고 있는 Java의 퍼센트도 조금은 줄 것으로 예상된다.
새로 작성한 README.md 둘러보기
README 파일의 가장 상단에는 큰 글씨로 프로젝트 명을 적고, 아래로는 간단한 소개 글귀를 만들고 그 아래로 몇몇의 섹션을 중간 크기 제목 사이즈로 만들었다.
나는 위에 도움을 받은 블로그에 있는 두 번째 README 템플릿을 기준으로 작성하고 있다.
때문에 맨 위에 목적과 용도에 대한 내용을 작성했고, 아직 개발 진행 중이므로 개발 환경 섹션을, 서비스 이용 방법과 업데이트 내역 섹션에는 '개발 중이다'라는 문구를 작성했다.
아래는 실제 마크다운 언어로 작성했던 README.md 파일을 캡쳐한 것이다.
마치며
README를 처음 작성하기 때문에 어떤 내용이 있으면 좋은지 혹은 없어야 하는 내용은 무엇인지에 대해서도 몰라서 헤매었었는데, 다행히 위에서 소개한 블로그의 도움을 받아 결정적으로 작성을 시작할 수 있었다!
그리고 깃허브 사이트에서 직접 README.md 파일을 수정하면 마크다운을 적용한 모습을 실시간으로 변환해서 볼 수 있는 게 편했던 것 같다.
감사합니다!!