Quais informações devem estar no github README.md?

10

Quais informações você espera ver no README do github?

Tudo deve estar no README? ie

  • Introdução

  • Instalação

  • Versões

  • Guia de usuario

  • Implementação

  • Teste

  • Recursos Relacionados

Ou você deve colocar certas coisas no README (Introdução, Instalação, Versões) e as outras informações são melhor colocadas no wiki do Github?

documentation github user86834
fonte
Eu colocaria os termos da licença também
py_script
Em termos excessivamente gerais, deve haver informações suficientes para me dizer se o projeto é útil para mim, se tudo o que sei é o nome. Não assuma nada sobre como o leitor a encontrou.
Keith Thompson
11
Esta questão tem uma boa resposta muito detalhada / aqui: stackoverflow.com/questions/2304863/how-to-write-a-good-readme
Rodrigo Graça

Respostas:

7

Espero ver uma introdução e uma breve visão geral. Deve haver algo para me convencer de que o projeto resolve um problema específico. Depois de ler o README, devo conhecer informações suficientes para saber o que o projeto faz, o que requer, como construí-lo e como usá-lo. Essas informações nem todas precisam estar no README, mas os links para essas informações devem estar.

Bryan Oakley
fonte
11
+1 para breve. Não diga "README" e coloque um monte de lixo que não precisa ser lido.
Korey Hinton