README 만들기

좋은 README 에 대한 제안

모든 프로젝트가 다르므로이 섹션 중 어느 것이 귀하에게 적용되는지 고려하십시오. 템플릿에 사용 된 섹션은 대부분의 오픈 소스 프로젝트에 대한 제안입니다. 또한 읽어보기가 너무 길고 상세 할 수 있지만 너무 길면 너무 짧은 것보다 낫다는 것을 명심하십시오. 추가 정보가 너무 길다고 생각되면 정보를 잘라내는 대신 다른 형태의 문서를 활용하는 것이 좋습니다. 프로젝트에 대한 자체 설명 이름을 선택하십시오.,

설명

사람들이 프로젝트가 구체적으로 무엇을 할 수 있는지 알려주십시오. 컨텍스트를 제공하고 방문자가 익숙하지 않을 수있는 참조에 대한 링크를 추가하십시오. 기능 목록 또는 배경 하위 섹션도 여기에 추가할 수 있습니다. 프로젝트에 대한 대안이 있다면,이것은 차별화 요소를 나열하기에 좋은 장소입니다.

배

에 몇 가지 추가 정보,당신이 볼 수있는 작은 이미지를 전달하는 메타데이터와 같은 모든 여부 테스트를 통과한 프로젝트입니다. 방패를 사용하여 추가 정보에 일부를 추가 할 수 있습니다. 많은 서비스에는 배지 추가 지침이 있습니다.,

영상

에 따라 만들기,그것은 좋은 생각이 될 수 있습을 스크린 샷을 포함하거나 심지어 비디오(당신은”종 Gif 보다 실제적인 비디오). Ttygif 와 같은 도구가 도움이 될 수 있지만보다 정교한 방법은 Asciinema 를 확인하십시오.

설치

내에서 특히 생태계 될 수있는 일반적인 방법을 설치하는 것과 같은 사용 원사,NuGet,또는 Homebrew. 그러나,당신의 README 를 읽는 사람이 초보자이며 더 많은 지침을 원할 가능성을 고려하십시오., 특정 단계를 나열하면 모호성을 제거하는 데 도움이되며 사람들이 프로젝트를 최대한 빨리 사용하도록합니다. 는 경우에만 실행됩 특정 컨텍스트에서 같은 특별한 프로그래밍 언어 버전이거나 운영 체제 또는 종속성을 수동으로 설치,또한 추가 요구 사항 하위 섹션이 있습니다.

사용법

예제를 자유롭게 사용하고 가능한 경우 예상 출력을 보여줍니다. 그것은”도움이 되는 인라인이 최소의 예를 사용할 수 있는 증명을 제공하면서,대한 링크를 더 정교한 예제는 너무 긴 경우 합리적으로 포함 추가 정보.,

지원

사람들에게 도움을 청할 수있는 곳을 알려주십시오. 이슈 트래커,대화방,이메일 주소 등의 조합이 될 수 있습니다.

로드맵

향후 릴리스에 대한 아이디어가 있다면 README 에 나열하는 것이 좋습니다.

공헌

당신이 공헌에 열려 있고 당신의 요구 사항이 그들을 받아들이 기위한 것이라면 진술하십시오. 프로젝트를 변경하려는 사람들을 위해 시작하는 방법에 대한 몇 가지 문서가 있으면 도움이됩니다., 아마도 그들이 실행해야하는 스크립트 또는 설정해야하는 일부 환경 변수가있을 것입니다. 이 단계를 명시 적으로 만드십시오. 이 지침은 미래의 자아에게도 유용 할 수 있습니다. 코드를 린트하거나 테스트를 실행하는 명령을 문서화 할 수도 있습니다. 이 단계는 높은 코드 품질을 보장하고 변경 사항이 실수로 무언가를 깨뜨릴 가능성을 줄이는 데 도움이됩니다. 는 지침에 대한 테스트를 실행하는 경우에 특히 도움이 필요한 외부 설정과 같은 시작 셀레늄 테스트를 위해 서버에서 브라우저입니다.,

저자 및 인정

프로젝트에 기여한 사람들에게 감사를 표시하십시오.

라이센스

오픈 소스 프로젝트의 경우 라이센스가 부여되는 방법을 말하십시오.

프로젝트 상태

실행한 경우의 에너지는 시간을 위해 귀하의 프로젝트를 넣어,상단의 메모리의 읽어보기 말하는 개발이 둔화되거나 완전히 중지. 사람이 선택할 수 있습니다 포크의 프로젝트 또는 자원봉사 단계로 유지 관리자 또는 소유자,수 있도록 귀하의 프로젝트를 보장합니다. 유지 관리자에 대한 명시적인 요청을 할 수도 있습니다.

---