Cómo usar: Generador de archivos README
- Elige el tipo de proyecto —biblioteca, aplicación/página web o sitio de Webflow— o carga uno de los ejemplos para ver un archivo README ya terminado.
- Rellena el nombre, el eslogan y la descripción. Añade tu repositorio de GitHub y el nombre del paquete para obtener automáticamente los comandos de instalación y las insignias.
- Añade características, un ejemplo de uso, opciones de configuración, variables de entorno y una hoja de ruta; las secciones vacías simplemente se omiten.
- Echa un vistazo a la vista previa en directo y a la lista de comprobación de que todo esté completo; después, copia o descarga el archivo README.md y súbelo a la raíz de tu repositorio.
¿Qué hace que un README sea bueno?
Un README es la portada de un proyecto. En GitHub, npm y PyPI es lo primero —y a menudo lo único— que lee la gente antes de decidir si lo usa, lo contrata o colabora en él. Los mejores archivos README responden a cinco preguntas en este orden: qué es, por qué debería importarme, cómo lo instalo, cómo lo uso y bajo qué licencia. Todo lo demás (configuración, hoja de ruta, cómo colaborar) sirve para respaldar esas respuestas.
La estructura que usa este generador
| Sección | Por qué está ahí |
|---|---|
| Título + insignias | Nombre, versión, estado de la compilación y licencia de un vistazo (insignias a través de shields.io). |
| Eslogan | Una frase que explique el proyecto; también la usan GitHub y los fragmentos de búsqueda. |
| Captura de pantalla | Para aplicaciones y bibliotecas de interfaz de usuario, una imagen es la explicación más rápida. |
| Características | Listas con viñetas fáciles de leer que ayudan a la gente a decidirse en segundos. |
| Instalación | Comandos exactos que puedes copiar y pegar en tu gestor de paquetes, además de .env variables. |
| Uso | El ejemplo más sencillo que funciona. Esta es la parte más leída de cualquier archivo README. |
| Configuración | Opciones en forma de tabla con tipo, valor por defecto y descripción. |
| Plan de desarrollo, cómo colaborar, licencia | Próximos pasos, cómo colaborar y cómo se puede usar el código. |
README para proyectos de Webflow y traspasos a clientes
Las páginas de Webflow no se guardan en un repositorio de Git, pero las agencias siguen necesitando documentación cuando una página cambia de manos. La plantilla de Webflow genera un archivo README para el traspaso: colecciones del CMS, integraciones, dónde se encuentra el código personalizado (configuración de la página frente a configuración del sitio), sistema de nomenclatura (por ejemplo, «Client-First») y la pila tecnológica. Guárdalo en la carpeta de tu proyecto o pégalo en una página de Notion. Combínalo con el «Class Name Typo Checker» antes de la entrega y añade un archivo llms.txt para que los asistentes de IA también entiendan el sitio.
Consejos de redacción
- Empieza por el resultado, no por la tecnología: «Convierte cualquier cadena en un slug compatible con URL» es mejor que «Una utilidad de TypeScript que utiliza la normalización Unicode».
- Haz que los ejemplos se puedan copiar y pegar y que se puedan ejecutar; nada de marcadores de posición que se rompan al pegarlos.
- Usa enlaces relativos para los archivos del repositorio (
./docs/setup.md,LICENSE) para que funcionen en bifurcaciones y ramas. - Mantén la documentación al día: un comando de instalación desactualizado hace más daño que un README breve.
- Los documentos de referencia largos deben ir en una
/docscarpeta; pon un enlace a ellos desde el README.
Elegir una licencia
Sin una licencia, el código tiene «todos los derechos reservados» por defecto: otros pueden leerlo, pero no reutilizarlo legalmente. Las licencias MIT e ISC son breves y permisivas; Apache 2.0 añade una concesión explícita de patentes, y la GPL v3 exige que las obras derivadas sigan siendo de código abierto. Para trabajos de clientes o de la empresa, elige «Propietaria». Esto no es un consejo legal; consulta choosealicense.com para más detalles. Recuerda añadir también el LICENSE .
¿Necesitas poner en orden el texto primero? El conversor de Markdown a HTML, el conversor de listas de tareas en Markdown y la herramienta de tablas de JSON a Markdown generan Markdown al estilo de GitHub que puedes pegar en el README.
También se busca como: generador de archivos «léeme», readme.md, plantilla de «léeme», archivo readme de github, archivo readme en markdown, documentación del proyecto, npm readme, creador de archivos «léeme».
Herramientas que combinan con: Generador de archivos README
- LICENSE File Generator — Add the right open-source license to your project in seconds.
- humans.txt Generator — Create a humans.txt that credits the team, contributors and technology behind your website.
- HTML Formatter — Paste minified or messy markup and get clean, consistently indented HTML — including embedded <style> and <script> blocks.
- CSS Formatter — Turn a minified stylesheet into readable CSS with one property per line and properly nested @media blocks.
Preguntas frecuentes
¿Dónde pongo el archivo README.md?
README.md en la página del proyecto.