README
El archivo de portada de un repositorio: qué es el proyecto, cómo se arranca y cómo se usa. GitHub lo muestra automáticamente al entrar.
✦Apagada: responde bien la pregunta del final para encenderla
También lo verás como: README · README.md · léeme
Analogía
La contraportada y las instrucciones de montaje de un mueble.
Qué lleva uno bueno
- Qué es y para quién
- Una captura o enlace a la versión publicada
- Cómo instalarlo y arrancarlo (los comandos exactos)
- Tecnologías usadas
- Estado del proyecto y contacto
Está escrito en Markdown.
Por qué importa para ti
- Es lo primero que ve un reclutador o un cliente en tu GitHub (Fase 14).
- Es lo que lee la IA (y tú dentro de seis meses) para entender el proyecto.
No confundir con
- CLAUDE.md: el README es para personas; CLAUDE.md es para la IA (reglas de trabajo, no presentación).
Un paso más: la prueba de un buen README
Dáselo a alguien que no conoce el proyecto y pregúntale dos cosas: ¿qué es esto? y ¿cómo lo arranco? Si puede responder a las dos sin preguntarte nada, el README funciona.
Lo que más se olvida son los comandos exactos. "Instala las dependencias y arráncalo" no ayuda; esto sí:
npm install
npm run dev
Con IA hay un beneficio extra: Claude Code lee el README cuando necesita entender un proyecto. Un README claro es contexto que no tienes que repetir.