📌 README
: 해당 Repository에 대한 설명을 위해 작성하는 안내문
- 프로젝트의 목적, 설치 방법, 사용 방법 등을 설명
🔺 README의 특징
- 보통 Repository의 최상위 폴더에 위치한다.
하위 폴더에도 별도의 README를 작성할 수 있다. - MarkDown(마크다운) 문법으로 작성된다.
✨ MarkDown
: 일반 텍스트 텍스트 문서에 서식 요소를 추가하는 데 사용할 수 있는 경량 마크업 언어
- Markup 언어에서 파생됨 (태그는 사용 X)
✨ Markup
: 텍스트를 정의하고 표현하기 위해 고안된 것 (ex. HTML)
🔺 README 작성 요건
- 최신 정보 제공
변경 사항이 생길 시 README도 함께 업데이트해야 함❗ - 간결하고 깔끔하게 작성
- 목차 구성
제목에 링크 설정
📍 README 구성 요소
- 프로젝트 주요 기능
- 프로젝트 목적
- 프로젝트 구성
- 프로젝트 설치 방법
- 프로젝트 프로그램 사용법
- 저작권 및 사용권 정보
- 프로그래머 정보
- 참고 및 출처
- 버전 및 업데이트 정보
- FAQ
📌 MarkDown 문법
줄바꿈
엔터(Enter) 2번
텍스트 강조
*문장*: Italic
**문장** : Bold
***문장***: Bold+Italic
~~문장~~: 취소선
코드 블럭
```코드```
인용
> : 인용문 작성
>> : 인용 안에 인용문 추가 작성
하이퍼링크
[링크 이름](링크, "부연설명")
- 부연 설명(링크에 마우스 오버 시 뜨는 값)은 선택 요소
이미지
* 이미지 링크 주소
1. Repository에 이미지 업로드 (Add file ➡ Upload files)
2. 업로드 된 이미지의 링크 주소 복사 (마우스 오른쪽)
참고
Getting Started | Markdown Guide
An overview of Markdown, how it works, and what you can do with it.
www.markdownguide.org
좋은 README 작성하는 방법
이 글은 ‘좋은 README를 작성하는 방법’을 다뤘습니다. README에는 항상 최신 정보를 담아야 합니다. 아울러 프로젝트에 변경 사항이 생길 때마다 README도 함께 업데이트해야 합니다. README에는 중
insight.infograb.net
Readme.md 파일 작성법
이번 포스팅에서는 여러분들의 Github Repository를 한층 업그레이드 시킬 수 있는 Readme.md 파일에 대해서 다뤄보겠습니다. 1. README 1) 개념 README 파일은 주로 Github 프로필 혹은 Repository에 대한 설명을
velog.io