README

JERRY·2025년 3월 14일
0

Git/GitHub

목록 보기
10/10
post-thumbnail

README 란?

  • 프로젝트에 대한 설명, 사용방법, 라이센스, 설치법과 같은 부분에 대해 기술하는 파일

  • 나, 직장동료, 프로그램 사용자를 위해 존재

  • README 예제


Markdown

  • 실습방법

    • GitHub 에서 README 파일 수정을 선택

    • 파일 수정 후 Commit

  • Text Size

    • Headers - 큰 제목

    • Headers - 작은 제목

    • Headers - 글머리 (1~6 까지 지원)

  • BlockQuote

    • 블럭인용문자 사용(>)

    • 혼합 - 블럭 내에서 다른 Markdown 요소를 포함할 수 있음

  • 목록

    • 순서가 있는 목록 (내림차순으로 자동 정렬)

    • 순서가 없는 목록

    • 순서가 없는 목록(혼합)

  • 코드블럭

    • 코드블럭 1
    • 코드블럭 2

  • 수평선

  • 외부링크

  • 자동연결

  • 강조

  • 이미지 : 업로드 되어 있는 사진만 사용 가능

    • GitHub 저장소에서 New Issue 클릭

    • Text Area 에 이미지 업로드(드래그) 하면 Markdown Link 가 생성 > 복사

    • README 에 붙여넣기

0개의 댓글