Generador de README

Crea un README perfecto para GitHub en minutos.

Template:
Secciones opcionales

Resumen — Qué hace Generador de README

Qué es esta herramienta gratuita

El Generador gratuito de README construye un README.md perfecto para GitHub desde un breve formulario. Elige una plantilla (Minimal, Standard, Library o Web App), rellena nombre del proyecto, descripcion, autor, comando de instalacion y codigo de uso, y obtendras un README pulido en segundos. Badges, licencia, seccion de contribucion y seccion de pruebas estan a un solo interruptor de distancia.

Privacidad: Esta herramienta se ejecuta completamente en tu navegador. Tu texto nunca se sube, registra ni almacena en caché. Cierra la pestaña y desaparece. Verifícalo en DevTools → Network: cero solicitudes.

Por qué es gratis (y cómo la mantenemos gratis)

Los buenos README son la diferencia entre un proyecto de codigo abierto que la gente usa y uno que la gente olvida. Queremos que cada herramienta gratuita, cada biblioteca indie, cada proyecto personal tenga un README decente. Por eso esto es gratuito para siempre.

Tabla de uso

Referencia rápida

EntradaSalidaTamaño típicoVelocidadInicio de sesión necesario
Form fieldsREADME.md (GitHub-ready)Any projectReal-timeNo

Características de Generador de README

Esto es lo que hace esta herramienta gratuita en detalle — cada función está diseñada para resolver problemas reales, se ejecuta completamente en tu navegador y es gratis para siempre.

4 plantillas de proyecto para diferentes tipos

Elige la plantilla que coincida con tu proyecto: Minimal (titulo + descripcion + licencia, para librerias de utilidad pequenas), Standard (agrega funciones y secciones de uso, para proyectos de codigo abierto tipicos), Library (agrega seccion de API con firmas de funciones, para librerias reutilizables), o Web App (agrega seccion Getting Started con clon de repositorio + instrucciones del servidor de desarrollo).

Una vez que tengas el texto del README, puedes renderizarlo a HTML con el Conversor de Markdown a HTML para previsualizar como se vera en la pagina de tu proyecto.

Badges de Shields.io generados automaticamente

Activa Incluir badges para agregar una fila de badges de shields.io en la parte superior de tu README: version npm, licencia y estado de build de GitHub Actions. Los badges se generan a partir del nombre de tu proyecto y usuario de GitHub.

Para una tabla de contenidos que enlace a cada seccion del README, usa el Generador de tabla de contenidos Markdown en la salida generada.

Selector de licencia con 6 opciones de codigo abierto

Elige entre MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC o Unlicense: las 6 licencias de codigo abierto mas comunes. La seccion de licencia del README se actualiza al instante, y si los badges estan activados, el badge de licencia se actualiza para coincidir.

Secciones opcionales de contribucion y pruebas

Activa la seccion Contributing para incluir un texto de bienvenida invitando pull requests e informes de problemas. Activa la seccion Tests para incluir instrucciones para ejecutar tu suite de pruebas. Ambas estan desactivadas por defecto en la plantilla Minimal; activadas por defecto en las demas.

Despues de generar, limpia cualquier inconsistencia con el Formateador de Markdown.

Cómo usar Generador de README

Paso 1 — Elige una plantilla

Selecciona Minimal, Standard, Library o Web App segun tu tipo de proyecto.

Paso 2 — Rellena el formulario

Nombre del proyecto, eslogan, descripcion, autor, comando de instalacion, codigo de uso, licencia.

Paso 3 — Activa secciones opcionales

Agrega o elimina badges, Contributing o secciones de Tests.

Quién puede usar esta herramienta

Open source maintainers

Shipping a polished README for every library release — no more 'figure out how to use this' friction.

Indie developers

Ship side projects with professional READMEs that make them look like real products.

Students building portfolios

Every project on your GitHub profile needs a README. This takes 2 minutes.

Hackathon teams

Ship your hackathon project with a real README even when you're running on 3 hours of sleep.

Technical writers

Starting from a solid template and customizing instead of staring at a blank file.

Preguntas frecuentes

Es realmente gratuito este generador de README?

Si. Todas las herramientas en freemarkdowntools.com son gratuitas para siempre.

Incluye badges?

Si. Badges de shields.io para version npm, licencia y estado de build estan incluidos por defecto. Desactivalos si no los quieres.

Que plantillas estan disponibles?

Minimal (titulo + licencia), Standard (agrega funciones + uso), Library (agrega seccion API), Web App (agrega Getting Started con clon de repositorio).

Puedo editar el Markdown generado?

Si. La salida es Markdown regular: copiala, pegala y personalizala en cualquier editor.

Se almacenan mis datos?

No. La herramienta se ejecuta 100% en tu navegador.

Herramientas Markdown gratuitas relacionadas