Lección 10 de 12 · Lectura y práctica
Crea un repo con README que vende el cambio
Repo con README Tu README es tu mejor vendedor. Explica que hace el proyecto, como correrlo y como probarlo. Conceptos clave Instalacion, scripts y estructura Como probar (pasos) Capturas si es UI Ejemplo README minimo: Que es ->.
Del concepto a la práctica
Taller de esta lección
Un README eficaz permite repetir el proyecto desde una carpeta limpia. Debe distinguir requisitos, instalación, scripts y comprobaciones; no debe prometer un comportamiento que el código no ofrece. Una estructura breve y verificable es más útil que una descripción extensa.
Ejemplo resuelto
Para un catálogo sin dependencias inventadas, el índice puede empezar así:
# Catálogo local
## Propósito
Muestra cursos y permite filtrarlos por categoría.
## Preparar
Clona el repositorio y ejecuta el comando de instalación indicado por el proyecto.
## Probar
Ejecuta `npm test`.
## Estructura
`src/` contiene lógica; `test/` contiene pruebas.Solo se incluyen comandos existentes en package.json.
Pruébalo
Lee los scripts reales del proyecto.
Escribe propósito y límite funcional.
Añade preparación, prueba y estructura.
Sigue el README en una copia limpia.
Error frecuente: documentar npm run deploy sin comprobar que exista. Corrección: compara cada comando con los scripts y registra el resultado real.
Comprueba tu resultado
Otra persona debe localizar la prueba y ejecutarla; el README debe coincidir con la estructura observada y no mencionar archivos inexistentes.

Mapa de prácticaLos cambios se preparan en una rama y se registran en commits pequeños. Las pruebas y la revisión del pull request comprueban el cambio antes de integrarlo. El historial permite entender qué se modificó y recuperar una versión anterior.
Ver la infografía en tamaño completo ↗Fuentes para profundizar
Repo con README
Tu README es tu mejor vendedor. Explica que hace el proyecto, como correrlo y como probarlo.
Conceptos clave
- Instalacion, scripts y estructura
- Como probar (pasos)
- Capturas si es UI
Ejemplo
README minimo: Que es -> Setup -> Scripts -> Como probar -> Deploy.
Ejercicio
- Crea un README de 20 lineas con secciones.
- Agrega un comando de prueba real.
Checklist de mastery
- Mi repo se entiende sin preguntarme.
- Incluyo pasos concretos para probar.
Sigue con Git y GitHub Pro
Esta lección forma parte de un curso de Cursalo. Revisa su programa y elige entre la compra individual o el acceso a toda la escuela.
Si ya tenías acceso a este curso, entra con tu cuenta: tus derechos y tu progreso se conservan. No necesitas comprarlo de nuevo.