내가 쓰는 Repository README 메뉴얼

README.md

Mandatory

1. Project introduction

해당 프로젝트 / 앱의 제목과 어떠한 프로젝트 / 앱인지를 간단하게 소개

2. Get Start

해당 프로젝트 / 앱을 실제로 이용하기 위한 실행 방식을 순차적으로 기재

3. License

해당 프로젝트 / 앱이 어떠한 라이센스를 이용중인지 기재

Autonomous

1. Prerequisites

해당 프로젝트 / 앱에 쓰인 개발, 기술 스택 사항을 기재

2. ScreenShots

해당 프로젝트 / 앱의 대표적인 실행 모습을 기재

3. Open-source libraries & SDK

해당 프로젝트/ 앱 개발에 이용된 오픈소스, SDK 주소 기재

---

README 기재 방식이야 천차만별이고 이것보다 더 나은 메뉴얼이 수두룩 하지만

내가 대표적으로 쓰고 있는 것들을 잊지 않으려고 여따 업로드 해본다

혹시나 더 좋은 메뉴얼이나 사항을 알고 계신분은 공유를 굽신굽신