¿Qué información debe estar en el github README.md?

10

¿Qué información esperarías ver en el archivo README de github?

¿Debería ir todo en el archivo README? es decir

  • Introducción

  • Instalación

  • Versiones

  • Guía del usuario

  • Implementación

  • Pruebas

  • Recursos Relacionados

¿O debería simplemente poner ciertas cosas en el archivo README (Introducción, Instalación, Versiones) y la otra información se ubica mejor en el wiki de Github?

documentation github usuario86834
fuente
También pondría los términos de la licencia
py_script
En términos demasiado generales, debería haber suficiente información para decirme si el proyecto es útil para mí si todo lo que sé sobre él es el nombre. No asumas nada sobre cómo lo encontró el lector.
Keith Thompson
1
Esta pregunta tiene una respuesta muy detallada / buena aquí: stackoverflow.com/questions/2304863/how-to-write-a-good-readme
Rodrigo Graça

Respuestas:

7

Espero ver una introducción y una breve descripción. Debería haber algo allí para convencerme de que el proyecto resuelve un problema particular. Después de leer el archivo README, debería conocer suficiente información para saber qué hace el proyecto, qué requiere, cómo construirlo y cómo usarlo. Esa información no necesita estar en el archivo README, pero los enlaces a esa información deberían estar.

Bryan Oakley
fuente
1
+1 para breve. No diga "README" y luego ponga un montón de basura que no necesita leerse.
Korey Hinton