저장소를 처음 연 사람에게는 코드보다 먼저 해결해야 할 질문이 있습니다. 이 프로젝트가 내 문제를 풀 수 있는지, 지금 쓰는 환경에서 실행할 수 있는지입니다.
작동하는 예시 하나로 시작하기
프로젝트가 받는 입력과 돌려주는 출력을 한 쌍으로 보여주세요. 예를 들어 로그 변환 도구라면 원본 한 줄과 변환 결과 한 줄이면 충분합니다. 독자는 상세 옵션을 읽기 전에 도구의 용도를 판단할 수 있습니다.
설치 과정을 새 환경에서 확인하기
지원하는 런타임 버전, 설치 명령, 첫 실행 명령을 순서대로 적습니다. 빈 디렉터리에서 지침을 직접 따라가면 개발자 환경에만 있는 설정을 발견하기 쉽습니다. 성공했을 때 보이는 출력도 짧게 덧붙입니다.
다음 행동으로 연결하기
예제와 상세 설정 문서, 이슈를 제보할 위치를 연결합니다. 버전이 바뀔 때는 첫 실행 예시도 함께 확인합니다.