README는 새 독자가 첫 유용한 행동을 하도록 도와야 합니다. 프로젝트가 무엇을 하고 자신과 관련 있는지 알기 전에 모든 구현 세부 사항을 설명할 필요는 없습니다.

결과부터 설명하세요

프로젝트가 무엇을 하고 누구를 위한 것이며 중요한 한계가 무엇인지 설명하세요. 형용사 목록보다 구체적인 예제가 유용합니다. 목적을 설명하는 데 도움이 된다면 작동 화면이나 결과 예시를 상단 가까이에 두세요.

그다음 운영체제, 런타임 버전과 필요한 서비스 등의 사전 조건을 적으세요. 선택 연동과 시작에 필요한 것을 구분하세요. 설치 도중 필수 조건을 처음 발견하게 하지 마세요.

성공까지의 완전한 경로 하나를 제시하세요

설정 단계는 실행해야 하는 순서대로 쓰세요. 명령을 어디에서 실행하고 성공 결과가 어떻게 보이는지 설명하세요. 예시 설정임을 명확히 표시하고 실제 인증 정보는 절대 넣지 마세요.

깨끗한 체크아웃이나 이에 준하는 시작 상태에서 안내를 시험하세요. 기기에 문서화되지 않은 도구가 설치되어 있어서만 작동하는 명령은 문서의 누락입니다. 선택적인 변형은 가장 단순한 지원 경로 아래에 두세요.

다음 단계를 쉽게 찾게 하세요

프로젝트 실행, 점검과 갱신에 쓰는 일반 명령을 추가하세요. 첫 섹션에 모든 전문 주제를 넣기보다 자세한 문서로 연결하세요. 문제를 보고할 공식 위치와 필요한 경우 라이선스를 포함하세요.

MeatPad에서 프로젝트 파일 옆의 README를 편집하고 게시 위치에서 렌더링된 Markdown을 확인하세요. 저장소의 실제 경로로 링크를 따라가고 이미지를 확인하세요. 설정이 바뀌면 같은 변경에서 README도 갱신해 처음 실행하는 안내가 사용자가 받는 버전을 설명하게 하세요.

출처 및 제품 정보

메모부터 시작하세요. MeatPad는 계정 없이 Mac에서 메모, Markdown과 프로젝트 파일을 위한 로컬 작업 공간을 제공합니다.

MeatPad 탐색 →