0. 목차

• 사용자들이 다른 섹션으로 쉽게 이동할 수 있는 목차

1. 동기

• 왜 이 프로젝트를 기획했나요?
• 이 프로젝트는 어떤 문제를 해결하나요?
• 이 프로젝트를 통해 무엇을 배우셨나요?
• 이 프로젝트의 특징은 무엇인가요?

2. 프로젝트명

먼저 프로젝트의 이름입니다. 한 문장으로 전체 프로젝트를 설명하고 사람들이 프로젝트의 주 목표가 무엇인지 이해할 수 있게 도와줍니다.

3. 프로젝트 설명

• 이 애플리케이션이 하는 일
• 사용한 기술과 이유
• 당면했던 문제
• 나중에 추가하고 싶은 기능

4. 프로젝트 설치 및 실행 방법

• 개발 환경을 세팅하고 실행할 수 있는 단계적인 설명

5. 프로젝트 사용 방법

• 사용자/기여자들이 프로젝트를 이용할 수 있는 방법과 예시
• 예상 문제에 대한 참고사항
• 프로젝트 실행 예시 화면의 스크린샷
• 프로젝트에서 사용된 구조나 디자인 원칙을 추가할 수 있습니다.

6. 팀원 및 참고 자료

• 팀원들의 깃허브 프로필과 SNS 링크
• 사용자가 프로젝트를 설치하는 데 도움을 줄 수 있는 튜토리얼이나 자료 링크

7. 라이센스

• 가장 흔한 라이센스는 다른 사람들이 여러분의 코드를 수정할 수 있고 상업적인 용도로 사용할 수 있는 GPL 라이센스입니다. 라이센스를 고를 때 도움을 받고 싶다면, 이 링크를 확인해 보세요: https://choosealicense.com/

8. 뱃지

• 다른 개발자들이 프로젝트에 대해 쉽게 알 수 있습니다.
• 중요한 툴로 연결해 주거나 포크, 기여자, 오픈된 이슈 등 프로젝트와 관련된 간단한 통계를 보여줄 수도 있습니다.
• shields.io에서 제공하는 뱃지를 확인

9. 프로젝트에 기여하는 방법

• 다른 개발자들이 프로젝트에 어떻게 기여할 수 있는지에 대한 가이드라인

10. 테스트

• 애플리케이션의 테스트를 위해 예제 코드와 실행 방식