README
프로젝트를 처음 보는 사람이 무엇을, 어떻게 실행해야 하는지 알 수 있도록 돕는 소개 문서이다.
README 는 쉽게 말하면 가이드라인, 설명서 정도로 생각할 수 있다.
README 파일에는 일반적으로 프로젝트에 대한 정보가 담겨 있다.
소프트웨어 배포시에 함께 포함되는데, 이러한 점이 새 제품을 구매했을때 읽어보는 사용 설명서와 비슷하다.
GitHub 에서는 README.md 파일이 자동으로 리포지토리 첫 화면에 표시된다.
Markdown 문법으로 작성해야 깔끔하게 정리된다. ( .md 확장자 )
작성 방법
파일 생성
- 프로젝트 루트 폴더 ( 최상단 ) 에 README.md 파일 생성
- Visual Studio / Visual Studio Code / Notepad++ 모두 가능하다
- 단 확장명은 반드시 .md 로 해야한다.
Markdown 기본 문법
# 큰 제목
## 중간 제목
- 목록 항목
**굵게** , *기울임* , `코드표시`
[링크텍스트](링크주소)
README 파일에 포함될 내용
- 프로젝트 소개 : 프로젝트의 주요 기능 , 목적
- 설치 및 사용법 : 프로젝트를 설치하고 실행하는 데 필요한 단계별 가이드
- 프로젝트 구성 : 프로젝트를 구성하고 있는 파일
- 제작자 : 프로젝트를 제작한 사람
- 기여자 : 프로젝트에 기여한 사람들
- 라이선스 : 프로젝트의 라이선스 정보
- 변경 로그 : 프로젝트의 변경 사항 기록
정리
- 가장 중요한 내용부터 : 프로젝트의 핵심 내용을 먼저 설명하여 사용자의 이해를 돕는다.
- 일관성 있는 스타일 : 프로젝트 전반에 걸쳐 일관된 톤과 스타일 유지
- 정기적인 업데이트 : 프로젝트가 변경 사항이 생길 때마다 README 를 최신 상태로 유지