README를 처음 쓴다면 멋진 배지보다 방문자가 프로젝트를 실행할 수 있는 정보를 먼저 배치하세요. 아래 예시는 실제 특정 프로젝트의 성과를 주장하는 문장이 아니라, 자신의 사실로 바꿔 쓰기 위한 구조입니다.
첫 문단 예시
“이 프로젝트는 사용자가 개인 일정의 중복을 확인하도록 돕는 웹 앱입니다. 저는 입력 검증과 중복 알림 기능을 구현했습니다.”처럼 대상, 문제, 본인 역할을 두 문장에 담습니다. ‘혁신적인 서비스’, ‘완벽한 성능’처럼 검증하기 어려운 수식어는 줄이세요.
실행 방법 예시
필요한 언어·런타임 버전, 의존성 설치 명령, 예제 환경 변수, 시작 명령을 순서대로 적습니다. 실제 비밀 키 대신 이름만 있는 예제 파일을 제공합니다. 처음 보는 사람이 새로운 환경에서 안내만 따라 실행해 보는 것이 가장 좋은 확인법입니다.
테스트와 한계 예시
“빈 제목을 입력하면 저장하지 않고 오류를 표시한다”처럼 확인 가능한 동작을 적습니다. 자동 테스트가 있다면 실행 명령을 연결하고, 없다면 수동 테스트 절차를 적습니다. 아직 지원하지 않는 기능과 알려진 문제도 밝히세요.
링크와 기여 범위
배포 주소와 주요 코드 위치, 팀 프로젝트의 개인 기여를 연결합니다. GitHub 공식 README 안내를 참고해 첫 화면에서 문서가 보이는지 확인하세요. 기능 목록형과 문제 해결형의 차이는 README 작성 방식 비교에서 확인할 수 있습니다.