Generador de README
Crea un README en Markdown limpio para tu proyecto sin escribirlo a mano. Rellena los datos del proyecto, marca las secciones que quieres y el generador ensambla el Markdown completo con insignias funcionales.
Combínalo con el Generador de Gitignore al configurar un repositorio, y previsualiza el resultado con Markdown a HTML.
Cómo usar Generador de README
- 1 Rellena el nombre del proyecto, la descripción y las secciones que quieres.
- 2 Elige bloques opcionales como insignias, pasos de instalación, ejemplos de uso y licencia.
- 3 Previsualiza el Markdown mientras avanzas.
- 4 Copia el archivo completo y pégalo en tu README.md.
Cómo usarlo
Completa los campos que necesites: cualquiera que quede vacío se omite. Activa o desactiva secciones y luego copia el Markdown en README.md de tu repositorio.
- Secciones opcionales, incluidas solo cuando se usan
- Insignias de Shields.io generadas automáticamente
- Bloques de instalación, uso, API y contribución
- Vista previa de Markdown en vivo
- Copia el archivo completo con un clic
Preguntas frecuentes
¿Qué debe contener realmente un README?
Por orden de utilidad: qué hace el proyecto, cómo instalarlo, cómo ejecutarlo y cómo contribuir. Una captura o un ejemplo de código breve cerca de arriba vale más que cualquier cantidad de prosa, porque la mayoría de los visitantes deciden en pocos segundos si el proyecto es lo que buscan.
¿Qué insignias merece la pena añadir?
Solo las que reflejan algo real y se mantienen al día: estado de compilación, cobertura de pruebas, versión publicada. Una insignia que muestra «compilación correcta» en un proyecto sin CI, o que no se ha actualizado en un año, es peor que no tener ninguna.
¿Debo incluir una sección de licencia?
Sí, aunque sea breve. Sin licencia, la configuración por defecto es que nadie puede reutilizar legalmente tu código, lo que disuade tanto a empresas como a colaboradores. Una sola línea que nombre la licencia y enlace al texto completo basta.
Generadores y varios relacionadas
También te puede interesar
Herramientas de otras categorías que suelen combinarse con Generador de README: