본문 바로가기
Tip/GitHub

[GitHub] README.md 파일이란?

by coding-choonsik 2023. 5. 1.
728x90
반응형
SMALL

 README.md 파일

  • 프로젝트나 레포지토리의 설명과 문서를 담는 텍스트 파일
  • 보통 프로젝트의 최상위 디렉토리에 위치하며, 프로젝트를 사용하는 사용자나 개발자에게 프로젝트의 목적, 사용 방법, 개발환경, 기여 방법 등을 안내하는 역할
  • Git hub에 업로드시 프로젝트 메인 설명글로 사용
  •  마크다운 문법으로 작성

 

마크다운 문법 

 

    1. 제목
         #       <h1></h1>
        ##      <h2></h2>
        ...
        ######  <h6></h6>

    2. 강조
         *이탤릭체* 또는 _이탤릭체_
        **볼드체**
        **_이탤릭체와 볼드체를 동시에_**
        ~~취소선~~
        <ul>밑줄<ul>

    3. 목록
        순서가 필요할 때
        1. 순서가 필요한 목록
        -  순서가 필요하지 않은 목록

    4. 링크
         [클릭할 문자열](URL)
        예) [google](https://google.co.kr)

 

 

 

 

728x90
반응형
LIST