Softonic

README 생성기

단계 1 / 4 README.md
다음

빈 저장소는 첫인상이 좋지 않습니다. 프로젝트 이름, 한 줄 태그라인, 기능 목록, 설치 명령어, 빠른 시작 코드, 작성자, 라이선스를 입력하면, 이 생성기가 올바른 제목 계층과 펜스 코드 블록을 갖춘 깔끔한 Markdown README, 즉 GitHub이 프로젝트 페이지에 표시하는 섹션들을 만들어 줍니다. 복사해서 저장소 루트에 README.md로 저장한 뒤 푸시하세요. 섹션 제목은 영어로 작성되며, 이는 오픈소스 README의 거의 보편적인 관례입니다. 반면 여러분이 입력한 내용은 어떤 언어든 입력한 그대로 표시됩니다.

README 작성 방법

  1. 1

    기본 정보 추가

    프로젝트 이름, 선택적 저장소 URL, 한 줄 태그라인. 이름은 `#` 제목이 되고, 태그라인은 그 아래 인용문이 됩니다.

  2. 2

    기능과 빠른 시작 나열

    한 줄에 기능 하나(각각 글머리 기호가 됩니다), 그리고 펜스 코드 블록으로 감싸지는 짧은 빠른 시작 코드.

  3. 3

    설치, 라이선스, 작성자

    설치 명령어는 「Installation」 아래의 `bash` 코드 블록에 들어갑니다. 라이선스(MIT, Apache-2.0…)와 선택적 작성자 줄을 추가하세요.

  4. 4

    마크다운 복사

    복사를 클릭해 출력을 저장소 루트에 `README.md`로 붙여넣으세요. 푸시하면 렌더링된 버전이 프로젝트 페이지에 표시됩니다.

좋은 README에 담기는 것

GitHub의 공식 스타일 가이드와 널리 쓰이는 standard-readme 사양은 순서에 대해 의견이 일치합니다. 훑어보기 좋은 부분을 위쪽에 두세요. 저장소에 들어온 사람은 20초 안에 계속 읽을지 결정합니다.

섹션 위치 목적
제목 + 태그라인 1~2행 # Project 뒤에 무엇을 하는지 한 문장
배지 3~5행 CI 상태, npm 버전, 라이선스, 커버리지
설치 첫 화면 위 누구나 복사할 수 있는 한 줄 명령어
사용법 첫 화면 위 출력을 만들어 내는 최소한의 코드 조각
API / 옵션 중간 플래그, 설정 키, 엔드포인트 표
기여 끝부분 CONTRIBUTING.md, 행동 강령, PR 관례 링크
라이선스 마지막 SPDX 식별자와 LICENSE 링크

실제로 도움이 되는 배지

Shields.io의 URL은 예측 가능한 패턴을 따릅니다: https://img.shields.io/badge/<label>-<message>-<color>.svg. 유용한 실시간 배지는 빌드 상태, 패키지 버전, 다운로드 수를 가리키며, 겉치레용 지표가 아닙니다. 보통 배지 네 개면 충분하고, 그 이상은 잡음입니다.

흔한 README 실수

  • 「설치」 첫 줄에 설치 명령어가 없음. 독자는 npm install이나 pip install을 눈으로 찾습니다. 산문 뒤에 숨기면 떠나 버립니다.
  • 3MB짜리 스크린샷. 너비를 800px로 줄이고 압축하세요. GitHub은 어차피 제공하지만, 모바일 독자는 데이터 비용을 부담합니다.
  • 오래된 배지. 빨간 CI 배지는 방문자에게 프로젝트가 고장 났다고 알립니다. CI를 고치거나 배지를 제거하세요.
  • 라이선스 누락. 라이선스가 없으면 여러분의 코드는 기본적으로 “모든 권리 보유”이며 기업은 사용할 수 없습니다.

자주 묻는 질문

네. 펜스 코드 블록, 글머리 기호 목록, ATX 스타일 제목(# 접두사)은 모두 변경 없이 GitHub, GitLab, Bitbucket에서 표시됩니다. 설치 명령어는 bash 블록으로 태그가 붙고, 빠른 시작 블록은 태그 없이 두어 직접 언어를 지정할 수 있습니다.

대부분의 생태계에서는 README.md입니다. 문서가 Read the Docs에 있고 Sphinx가 그 파일을 랜딩 페이지로 재사용하기를 원하는 Python 패키지를 배포할 때만 .rst를 사용하세요.

저장소 URL을 제공하면 생성기가 정적 라이선스 배지 하나를 추가합니다(https://img.shields.io/badge/license-<type>-blue.svg). 실시간 배지(빌드 상태, 버전, 다운로드 수)가 필요하면 shields.io URL 패턴을 복사해 출력에 직접 붙여넣으세요.

아니요. README는 양식 값으로 조립되며 아무것도 저장되지 않습니다. 탭을 닫으면 데이터가 사라집니다.

관련 도구

ASCII 표 참조

NUL, LF, DEL 같은 제어 문자를 포함해 모든 문자에 대한 10진수, 16진수, 8진수, 2진수, HTML 숫자 문자 참조를 담은 0부터 127까지의 전체 ASCII 표.

HTML 문자 참조

HTML 엔티티의 검색 가능한 목록, 각 엔티티의 이름 및 숫자 코드, 그리고 특수 문자 및 기호에 대한 1클릭 복사 기능을 제공합니다.

FPS 카운터

requestAnimationFrame으로 브라우저 FPS를 측정하세요. 스무딩, 최소/최대 프레임레이트, 경고 임계값, 선택형 그래프를 제공합니다. 업로드나 API 없이 로컬에서 실행됩니다.

키보드 단축키 참고표

macOS, Windows, Linux에서 VS Code, Chrome, GNU Readline을 쓰는 Bash의 문서화된 기본 단축키를 검색합니다.

보색 찾기

어떤 입력에 대해서도 보색을 찾습니다. HSL 반대 색, 분할 보색 쌍, 그리고 접근성 있는 조합 제안을 반환합니다.

색상 틴트 생성기

기준 색의 밝은 틴트를 생성합니다. 디자인 시스템 토큰, 배경, 호버 상태를 위한 3-20단계 스케일.

이 도구는 다른 언어로도 제공됩니다