Monta un README.md sólido en cinco minutos
Tu README es lo primero que ve alguien al aterrizar en tu repositorio. Un README malo puede enterrar un gran proyecto: sin pasos de instalación, sin ejemplo de uso, sin badges shields.io, un muro de texto. Un buen README tiene estructura: nombre, descripción, quick start, uso, características, licencia.
Esta herramienta construye un README.md completo desde un formulario. Cada sección es un toggle Switch: activa título, badges, índice, instalación, uso, características, tabla de configuración, capturas, stack tech, contribución, licencia, agradecimientos, footer. Rellenas campos, el panel derecho muestra el Markdown renderizado como lo renderiza GitHub (motor: marked).
Copia el resultado o descárgalo como fichero. Todo corre en el navegador, nada sale de tu máquina.
Cómo usarlo
- Activa las secciones que quieras pulsando los chips arriba. Cada sección activada aparece como pestaña en el editor de abajo.
- Elige una pestaña de sección en el editor (Badges, Características, ...) y rellena los campos. Tab cicla por los inputs, la salida se refresca según escribes.
- Badges: elige una licencia, pega el repo para build status, pega el nombre del paquete para versión y descargas npm/PyPI. El generador construye las URLs shields.io por ti.
- Quick Start: elige un gestor de paquetes (npm/yarn/pnpm/bun/pip/cargo/go), escribe el nombre del paquete, obtén un comando de install listo dentro de un bloque de código.
- Tech Stack: pulsa las tecnologías que uses. Aparecen como lista de bullets en la sección "Tech Stack".
- Preview a la derecha renderiza Markdown en vivo. Cambia a "Markdown" para ver el fichero raw que copiarás o descargarás.
- Copiar (fichero completo al portapapeles) o Descargar (guardar como README.md). Suelta en tu repo, listo.
Cuándo es útil
Situaciones concretas en las que este generador ahorra tiempo real:
- Un repo GitHub recién creado. Clonaste un boilerplate, tienes un README.md vacío. En vez de escribir desde cero o copia-pegar de otro proyecto, montas un fichero coherente aquí y lo pegas en cinco minutos.
- Un paquete npm / PyPI / cargo crate. Un buen README no es solo una descripción, es un badge de versión (la gente ve que el paquete se mantiene), un badge de descargas (prueba social), un badge de licencia (para que la gente sepa que puede usarlo), un badge de build (para que la gente vea que nada está roto ahora mismo). El generador construye las cuatro URLs shields.io por ti.
- Onboarding de nuevos compañeros. Una plantilla README estándar ayuda a juniors a escribir documentación sin preguntarse "¿qué pongo aquí?". Activa "Quick Start" y "Configuración", el resto se escribe solo.
- Un hackathon o prototipo. Tienes dos días y un trozo de código funcional que tiene que verse profesional. Un README con badges, capturas y una sección "Features" decente es la diferencia entre "proyecto de clase" y "producto".
- Migrar un proyecto viejo. El README antiguo son tres líneas y un comando de install obsoleto. Escribes los datos aquí, generas un fichero nuevo, commiteas.
- README para un repo de portfolio. Si tu CV enlaza un repo, el README es la landing. Imagen hero, descripción, badges, stack, contacto, todo montado aquí.
Tras generar, pasa el fichero por nuestro linter Markdown para pillar los pequeños problemas habituales (niveles de heading saltados, bullets mezclados, code fences sin tag de lenguaje). Si quieres añadir un índice a un fichero grande existente, usa el generador de TOC Markdown.