README 작성하기

GitHub 개념 입문

Jasmin Ludolf

Content Developer, DataCamp

README 편집하기

축구 분석 저장소 화면

GitHub 개념 입문

README 편집하기

README 파일이 강조된 축구 분석 저장소 화면

GitHub 개념 입문

README 편집하기

README 파일 편집 연필 아이콘이 강조된 축구 분석 저장소 화면

GitHub 개념 입문

마크다운

README 파일 화면

GitHub 개념 입문

편집 vs. 미리보기

편집 및 미리보기 탭이 강조된 README 파일 화면

GitHub 개념 입문

제목

가장 큰 제목 구문이 있는 마크다운 파일 편집 페이지

가장 큰 제목이 표시된 마크다운 파일 미리보기 페이지

GitHub 개념 입문

제목

6가지 제목 유형 구문이 있는 마크다운 파일 편집 페이지

6가지 제목 유형이 표시된 마크다운 파일 미리보기 페이지

GitHub 개념 입문

제목

6가지 제목 유형 구문이 있는 마크다운 파일 편집 페이지]

6가지 제목 유형과 1단계·2단계 제목 아래 선을 가리키는 화살표가 표시된 마크다운 파일 미리보기 페이지

GitHub 개념 입문

텍스트 서식

굵게 및 기울임 구문이 있는 마크다운 파일 편집 페이지

굵게 및 기울임 텍스트가 표시된 마크다운 파일 미리보기 페이지

GitHub 개념 입문

하이퍼링크

하이퍼링크 구문이 있는 마크다운 파일 편집 페이지

하이퍼링크가 표시된 마크다운 파일 미리보기 페이지

GitHub 개념 입문

하이퍼링크

하이퍼링크를 클릭하는 애니메이션 화면

GitHub 개념 입문

이미지

이미지를 마크다운 파일로 드래그하면 GitHub가 자동으로 구문을 렌더링하는 애니메이션 화면

GitHub 개념 입문

README 작성하기

  • 구체적으로 작성해야 함
    • 누구나 프로젝트를 이해할 수 있어야 함
  • 저장소 내용 목록 포함
  • 프로젝트를 명확하게 설명

열린 책 일러스트

GitHub 개념 입문

README 기본 요소

  • 제목
  • 기술 스택 설명
    • 이유
  • 프로세스 설명
    • 이유
  • 목차
GitHub 개념 입문

README 추가 요소

  • 프로젝트 배경
  • 동기
  • 한계
  • 어려움
  • 해결하려는 문제
  • 사용 목적
  • 크레딧
GitHub 개념 입문

연습해 봅시다!

GitHub 개념 입문

Preparing Video For Download...