Cuándo usarla

Empieza con esta plantilla cuando publiques una librería, una herramienta de línea de comandos o un servicio interno y necesites documentación que responda las tres primeras preguntas: qué es, cómo se instala, cómo se ejecuta. La leen desarrolladores y revisores, y también clientes que reciben el README como PDF en un paquete de entrega.

Qué incluye

• Un título construido a partir de un campo por completar para el nombre de tu proyecto, con una descripción de una frase debajo.
• Secciones de instalación y uso, cada una con un bloque de código para un comando de terminal o un ejemplo de código.
• Una sección de contribución que pide abrir un issue antes de un cambio grande.

Consejos para un mejor documento

• Prueba el comando de instalación en una máquina limpia antes de publicar. Un README que falla en el primer paso pierde a la mayoría de los lectores.
• Esta plantilla usa el estilo Técnico de forma predeterminada, que pone los bloques de código en una fuente monoespaciada y mantiene las líneas largas dentro de la página al exportar.