홈 › 처음 사용 설명서 › 2
깃허브 처음 사용 설명서 2/6

README 읽는 법 — 이 프로그램이 뭔지 1분 만에 파악하기

저장소에 들어가면 파일 목록 아래에 긴 설명 글이 보여요. 이게 README(리드미, '읽어 주세요')예요. 만든 사람이 직접 쓴 사용 설명서라서, 여기만 잘 읽어도 대부분 해결돼요.

이 순서로 보세요

  1. 맨 위 한두 줄 — 프로그램이 무엇인지 한 문장으로 적혀 있어요. 스크린샷이나 움직이는 그림(GIF)이 있으면 결과물을 바로 볼 수 있어요.
  2. Features (기능) — 무엇을 할 수 있는지 목록이에요.
  3. Installation / Getting Started (설치·시작하기) — 설치 방법이에요. 'Download'나 'Releases'라는 말이 있으면 설치 파일을 받는 방식이고, 명령어(검은 상자)만 있으면 설치형 도구예요.
  4. Usage (사용법) — 실제로 쓰는 방법과 예시예요.
  5. Requirements (필요 조건) — 윈도우·맥 지원 여부, 필요한 프로그램(Python, Node.js 등)이 적혀 있어요. 내 컴퓨터에서 되는지 여기서 먼저 확인하세요.
  6. License (라이선스) — 이 코드를 어떻게 써도 되는지 규칙이에요. 오른쪽 사이드바에도 표시돼요.

오른쪽 사이드바도 확인하세요

About
한 줄 설명과 공식 웹사이트 링크가 있어요. 웹사이트가 있으면 설치 없이 바로 써 볼 수 있는 경우도 있어요.
Releases
숫자(예: v1.2.0)가 있으면 완성된 설치 파일이 있다는 뜻이에요.
별·포크·마지막 업데이트
최근까지 업데이트되는 프로젝트가 문제가 생겼을 때 고쳐질 가능성이 높아요.
💡 깃트렌드KR의 저장소 페이지에서 '바로 쓰는 앱 / 설치해서 쓰는 도구 / 개발용 부품' 표시를 먼저 보면, README를 읽기 전에 나에게 맞는지 감을 잡을 수 있어요.
광고 영역