github README.md에 어떤 정보가 있어야합니까?

github README에 어떤 정보가 있습니까?

모든 것이 README에 들어가야합니까? 즉

소개
설치
버전
사용자 설명서
이행
테스팅
관련 자료

아니면 README (소개, 설치, 버전)에 특정 내용을 넣고 다른 정보는 Github Wiki에 가장 잘 배치됩니까?

documentation github

— 사용자
소스

나는 또한 라이센스 조건을 둘 것이다

— py_script

지나치게 일반적인 용어로, 내가 아는 모든 것이 이름이라면 프로젝트가 나에게 유용한 지 여부를 알려주는 충분한 정보가 있어야합니다. 독자가 그것을 어떻게 찾았는지에 대해 아무 것도 가정하지 마십시오.

— Keith Thompson

이 질문은 여기에 매우 상세하고 좋은 답변이 있습니다 : stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

소개와 간략한 개요를 볼 것으로 기대합니다. 프로젝트가 특정 문제를 해결했다는 것을 확신시킬 수있는 것이 있어야합니다. README를 읽은 후에는 프로젝트가 수행하는 작업, 필요한 작업, 빌드 방법 및 사용 방법을 알 수있는 충분한 정보를 알아야합니다. 이 정보가 모두 README에 있어야하는 것은 아니지만 해당 정보에 대한 링크가 있어야합니다.

— 브라이언 오클리
소스

간단한 +1 "README"라고 말하지 말고 읽을 필요가없는 많은 쓰레기를 넣으십시오.

— Korey Hinton