El README y Markdown
Cuando alguien entra en tu proyecto, lo primero que ve es el README: la carta de presentación. Y se escribe en Markdown, una forma sencillísima de dar formato al texto que, además, te va a servir en muchos otros sitios.
Escucha la lección
El README: la portada de tu proyecto
El README (que en inglés es "léeme") es un archivo que describe tu proyecto: qué es, para qué sirve y cómo se usa. Es lo primero que aparece cuando alguien abre tu repositorio, así que es tu primera impresión.
Es un archivo normal, que se llama README.md (en mayúsculas, por costumbre). Dentro escribes lo que quieras contar: una presentación, instrucciones, lo que sea. Un buen README hace que tu proyecto parezca cuidado y profesional, aunque sea sencillo.
¿Y esa extensión .md?
Esa terminación .md significa que el archivo está escrito en Markdown. Markdown es una manera de dar formato al texto escribiendo símbolos sencillos, sin botones. En vez de seleccionar una palabra y pulsar "negrita", escribes el símbolo y ya está.
Es facilísimo y lo entenderás con cuatro ejemplos.
Markdown en cuatro trazos
| Si escribes... | Sale... |
|---|---|
# Mi título | Un título grande |
**importante** | La palabra en negrita |
*ojo* | La palabra en cursiva |
- café (con guion) | Un punto de una lista |
[mi web](https://...) | Un enlace que se puede pulsar |
Y poco más. Con esos cinco trucos ya puedes escribir un README estupendo.
Lo mejor: Markdown está en todas partes
Aprender Markdown no te sirve solo para Git. Lo usan Notion, WhatsApp, Telegram, Discord, ChatGPT y un montón de herramientas más. Esos asteriscos para poner algo en negrita que igual ya usabas en WhatsApp... eso es Markdown. Así que esta lección te da una habilidad que vas a aprovechar mucho más allá de este curso.
Consejo: el README es de las pocas cosas de Git que se ven "bonitas" desde el primer momento. Dedícale un ratito al de tu primer proyecto — da gusto y se nota.
¿No programas? Te lo explico fácil · sin tecnicismos
Piensa en un libro.
El README es como la portada y la contraportada juntas: el título, de qué va, y esas líneas que te cuentan lo justo para saber si te interesa. Cuando alguien "coge tu libro" (entra en tu proyecto), es lo primero que lee.
Y Markdown son como los botones de formato de un procesador de textos —poner en negrita, hacer una lista, un título— pero en vez de hacer clic en un botón, escribes un símbolo. Una almohadilla para un título, dos asteriscos para negrita.
Suena raro al principio, pero en cinco minutos le pillas el truco. Y es de esas cosas que, una vez aprendidas, usas en mil sitios sin darte cuenta.
Glosario
README
Archivo (normalmente README.md) que documenta y presenta un proyecto. Se muestra automáticamente en la página principal del repositorio.
La carta de presentación de tu proyecto: qué es y cómo se usa. Lo primero que ve quien entra.
Markdown
Lenguaje de marcado ligero que permite dar formato a texto plano mediante símbolos sencillos, convertible a HTML.
Una forma fácil de dar formato al texto escribiendo símbolos. La usan WhatsApp, Notion y muchas más.
Extensión .md
Extensión de archivo que indica que su contenido está escrito en Markdown.
La terminación de los archivos escritos en Markdown, como README.md.