[Github] 팀프로젝트 README.md 작성하기

2022년, 팀원들과 함께 RPG게임 프로젝트를 제작했다. 최종적으로 merge를 한 후, 게임 대회에 제출을 하며 활동이 마무리되었다. 대회에 제출을 위한 서류 작업은 진행되었지만, 막상 프로젝트 협업이 진행되었던 깃허브엔 자세한 프로젝트에 대한 설명은 기재하지 않았다.

필자는 텅 비어있던 README.md가 늘 신경 쓰였다. 프로젝트의 제대로 된 마무리는 깃허브에 프로젝트의 소개을 작성하는 것이라 생각하였기에, 2023년 2월 리드미를 혼자 작성하게 되었다.

 

진행한 프로젝트는 많았으나, 대개 혼자 진행한 프로젝트만 README를 작성하거나 작성하지 않는 편이었다. 즉, 팀 프로젝트 차원의 README는 처음이란 말. 규모가 큰 프로젝트였기에, 길었던 개발 과정을 하나의 글로 녹여내는 것엔 어려움이 있었다. 검색과 고민과 고민의 끝에, README를 완성했다.

 

이번 글은 텅- 비어있던 README를 채우는 과정에 대한 이야기이다.

---

먼저, 완성된 README를 먼저 제시하도록 하겠다.

완성된 README는 다음과 같다.

 

🎯 깃허브 주소: https://github.com/JeongHyunJi/SosoVillage

GitHub - JeongHyunJi/SosoVillage: Healing RPG Game 🌽⛏️🏕️

 

🎯 실제 작성된 README.md

---

README를 크게 세가지의 블록(게임 소개, 목차, 세부 설명)으로 나누어 구성했다.

 

1. 게임 소개

헤더 부분을 가장 중요하게 생각해서, 간략한 게임에 대한 설명을 작성했다.

마크다운으로 작성된 이미지는 중앙정렬 기능을 포함하고 있지 않아, 부득이하게 이미지는 첨부하지 못하였다. 중앙정렬이 필요 없다면 이미지를 첨부하는 것도 좋은 선택일 것이다. 이미지 첨부는 해당 링크를 참고하길!

[깃허브] README.md에 이미지 추가하는 방법

필자는 중앙정렬이 필요해, 이미지 첨부를 포기하고 html을 이용해 코드를 작성했다.

 

2. 목차

내용이 그렇게 길진 않지만, 목차가 있는 것과 없는 것의 차이는 분명하다. 목차가 있음으로 인해 README가 정렬되어 보이는 효과가 있다. 또한 읽는 이에게 어떠한 내용으로 진행이 될 것인지 제시해주기에, 프로젝트에 대한 이해도를 더 높일 수 있다. 

마크다운으로 목차를 작성하는 방법은 다음과 같다.

## 목차
  - [보이는 텍스트](#이동할 부분)

[보이는 텍스트]: 실제 화면에서 보이는 텍스트를 작성하는 부분이다.

(#이동할 부분): #뒤에 실제로 이동할 부분을 작성하는 부분이다. 영어는 소문자만 가능하며, 띄어쓰기는 -로 표시한다.

다음 이미지를 예시로 들어 설명하겠다.

## 목차
  - [개요](#개요) 

## 개요
- 프로젝트 이름: SosoVillage 🏠
- 프로젝트 지속기간: 2022.02-2022.06
- 개발 엔진 및 언어: Unity & C#
- 멤버: 팀 정현지(이정현, 김민정, 김민지)

목차(## 목차)에 있는 개요([개요])를 클릭한다면, 개요(## 개요)로 이동하게 된다.

본인이 개요로 이동하는 것을 연결하고 싶다면, 목차에 [개요](#개요)를 표시하면 된다.

 

3. 세부 설명

본인이 개발한 프로젝트에 따라 내용 전개에 차이가 있으리라 판단된다. 필자가 개발한 분야는 게임이었기에, 게임 소개와 플레이 방식에 집중을 한 설명을 기재했다.

 

• 게임 소개

: 게임의 개발 동기, 차별점, 강조할 점을 중심으로 작성했다. 소소빌리지의 경우, 캐주얼 및 힐링을 키워드로 개발한 RPG게임이기에 사용자에게 편안함을 제공하기 위해 디자인과 음악에 신경을 쏟은 편이었다. 이 점에서 파생되는 특징들을 서술하며, 게임 소개를 마무리지었다.

프로젝트에 대해 제대로 소개하자면, 무한 스크롤을 내릴 정도로 적을 수 있는 부분이 소개 부분이기에 최대한 간결하게 적되 핵심을 전달하고자 노력했다.

• 게임 플레이 방식

: 텍스트보다 이미지가 전달하는 바가 훨씬 크다고 생각해, 마크다운 테이블 기능을 활용해 작성을 했다. 캐릭터>맵>미니게임으로 확장해 나가며 읽는 이가 게임에 대해 점진적으로 파악이 가능하도록 유도했다.

---

 

프로젝트와 수많은 시간을 씨름한 사람은 바로 당신이기에, 틀에 박힌 예시보다, 자신이 개발 과정에서 주목한 부분을 README에 작성한다면 프로젝트를 소개하는 것에 있어 더 큰 역할을 할 것이라 생각한다.

이 글이 팀 프로젝트 README 작성에 어려움을 겪고 있는 개발자 모두에게 도움이 되었길 바란다. 🍀