모범 사례

https://github.com/eliotjang/the-last-rollback-server

Readme 구성 요소

• 프로젝트 소개

  • 프로젝트 이름
    • 간단하고 직관적인 이름이 좋습니다.
  • 프로젝트 개요

    • 프로젝트가 어떤 문제를 해결하고자 하는지, 혹은 목표가 무엇인지 1 ~ 2 문장 정도로 짧게 기술하면 지나가던 사람도 어떠한 프로젝트인지 빠르게 파악할 수 있겠죠?

    • 예시:

      이 프로젝트는 텍스트 기반의 RPG 게임입니다.

      주요 콘텐츠는 ~~이며 해당 프로젝트를 통해 ~~ 하고자 하였습니다.

  • 주요 기능 요약
    • 프로젝트에서 구현된 핵심 기능들을 간단히 나열합니다.
  • C++에서 어떤 라이브러리를 사용하는지, STL(표준 라이브러리)을 어떻게 활용했는지도 함께 언급하면 좋겠죠?!

• 개발 환경

  • 개발 언어 및 도구
    • C++ 컴파일러 버전, IDE 혹은 빌드 툴 등을 명시합니다.
    • 예시:
      • IDE: Visual Studio 2022
      • Compiler: MSVC 14.XX / C++17 이상
      • CMake 3.X 이상
  • 빌드/실행 방법
    • 어떻게 빌드하고 실행하는지 명확하게 작성합니다.
    • 처음 접하는 사람이 알아보기 쉽게 간단히 순서를 정리해주세요.
  • 의존 라이브러리/패키지
    • 팀 프로젝트에서 추가로 사용한 라이브러리가 있다면 추가적으로 작성해놓습니다!
    • 버전 정보를 포함해두면 나중에 버전 차이로 인한 문제를 예방하기 좋아요.
    • 나중에, 언리얼 기반 프로젝트의 경우에 플러그인 정보도 명세해놓으면 좋습니다.

• 프로젝트 구조

  • 디렉터리 구조를 간단히 보여주고, 각 폴더가 어떤 용도인지 설명해주세요.

  • 프로젝트 구조 예시

    
    MUD_RPG_PROJECT
     ┣ src
     ┃ ┣ main.cpp // 메인 함수 진입점
     ┃ ┗ game // 게임 디렉토리 (필요한 헤더 파일, 구현부 파일 위치)
     ┃ ┃ ┣ character.h // 캐릭터 시스템 헤더
     ┃ ┃ ┣ character.cpp // 캐릭터 시스템 구현
     ┣ tests // 테스트 코드
     // 이외에 필요한 디렉토리 혹은 파일들...
    

• 핵심 로직/클래스 설명

  • 주요 클래스와 함수에 대해 개략적인 설명을 추가합니다.
  • 프로젝트 내에서 특별히 고민하고 구현한 부분을 꼭 작성해주세요!
    • 예를 들어 알고리즘이나 자료구조를 독창적으로 설계했다면 쓸게 더 있겠죠?

• 과제 추가 구현 사항 (추가 구현을 했다면 필히 작성!)

  • 팀에서 기본 요구사항 외에 독창적으로 구현한 과제 내용을 반드시 작성해주세요.
  • 어떤 동기가 있었고, 어떻게 구현했는지 간단히 요약하는 정도로도 충분합니다.

• 주의사항

  • 아직 수정되지 않은 버그나, 실행 시 주의해야 할 점이 있다면 간단히 정리합니다.
  • 빌드 환경마다 발생할 수 있는 호환성 이슈가 있다면 이런 것도 적어주시면 좋아요!