- 해당 프로젝트의 목차, 설명서,기술적 정의를 목적을 작성되는 가이드북 개념.
- 프로젝트 구성
- 프로젝트 프로그램 설치방법
- 프로젝트 프로그램 사용법
- 저작권 및 사용권 정보
- 프로그래머 정보
- 버그 및 디버그
- 참고 및 출처
- 버전 및 업데이트 정보
- FAQ
- MarkDown Language를 사용
- 제목
- 줄바꿈
- 구분선
- 순서
- 불릿
- 텍스트 강조
- 인용구
- 하이퍼링크
- 이미지
- etc...
- git Repository 에 프로젝트를 업로드 했을때
해당 프로젝트의 최상단 경로에 위치
생성 및 적용 방법
-
readme.md 이름으로 프로젝트 내 최상위 폴더에 파일 추가
-
마크다운 언어를 사용해서 작성
-
git push
-
git repository에 접근시 하단에 readme.md 파일 내의 내용이 출력되는것을 확인
기억저장소