> misión 2/7 · 25 min

Escribe un buen README

Mensaje de Daniela Fuentes, analista de datos y tu mentora en esta ruta

Revisé tu repositorio: está creado, pero el README dice solo el nombre. Cuando alguien entra a un proyecto, lo primero que lee es el README, y si no entiende de qué se trata, se va. Te dejo un ejercicio: escribe el README de un análisis de despachos de una pyme. Tiene que tener título, secciones, una lista de los datos, una tabla con un resultado y un enlace.

Concepto

Los README se escriben en Markdown: texto normal con algunos símbolos que le dan formato.

# Título principal
## Subtítulo

- un elemento de lista
- otro elemento

1. primer paso
2. segundo paso

| Comuna | Despachos |
| --- | --- |
| Maipú | 120 |

**negrita** y `código`

[texto del enlace](https://github.com)
![descripción de la imagen](https://ejemplo.cl/grafico.png)

Tres detalles que causan la mayoría de los errores:

  • Después de # o de - va un espacio: # Título, no #Título.
  • Una tabla necesita la línea | --- | --- | bajo los encabezados.
  • Entre un párrafo y una lista o tabla va una línea en blanco.

> tarea de Markdown

Escribe el README del análisis de despachos: un título, al menos dos subtítulos, una lista, una tabla y un enlace. Mira la vista previa mientras escribes.

Tu README debe tener

  • ○ titulo
  • ○ subtitulos:2
  • ○ lista
  • ○ tabla
  • ○ enlace

Vista previa

Primero intenta: las pistas aparecen después de 2 intentos con un resultado incorrecto (los errores de código no cuentan). Llevas 0.

> decisión

Un compañero te pasa su README: dice solo 'proyecto final, ver archivos'. ¿Qué es lo más importante que le falta?

Cargando opciones…

Aprueba las tareas de esta misión para ver el cierre.