Crear un README

Introducción a los conceptos de GitHub

Jasmin Ludolf

Content Developer, DataCamp

Editar el README

Vista del repositorio de análisis de fútbol

Introducción a los conceptos de GitHub

Editar el README

Vista del repositorio de análisis de fútbol con el archivo README resaltado

Introducción a los conceptos de GitHub

Editar el README

Vista del repositorio de análisis de fútbol con el icono de lápiz para editar el README resaltado

Introducción a los conceptos de GitHub

Markdown

Vista del archivo README

Introducción a los conceptos de GitHub

Edición vs. Vista previa

Vista del archivo README resaltando las pestañas de edición y vista previa

Introducción a los conceptos de GitHub

Encabezados

Vista de la página de edición de un archivo Markdown con la sintaxis del encabezado más grande

Vista de la vista previa de un archivo Markdown con el encabezado más grande

Introducción a los conceptos de GitHub

Encabezados

Vista de la página de edición de un archivo Markdown con la sintaxis de los seis tipos de encabezado

Vista de la vista previa de un archivo Markdown con los seis tipos de encabezado

Introducción a los conceptos de GitHub

Encabezados

Vista de la página de edición de un archivo Markdown con la sintaxis de los seis tipos de encabezado]

Vista de la vista previa de un archivo Markdown con los seis tipos de encabezado y flechas que señalan las líneas bajo el encabezado uno y dos

Introducción a los conceptos de GitHub

Formato de texto

Vista de la página de edición de un archivo Markdown con la sintaxis de negrita y cursiva

Vista de la vista previa de un archivo Markdown con texto en negrita y cursiva

Introducción a los conceptos de GitHub

Hipervínculos

Vista de la página de edición de un archivo Markdown con la sintaxis de un hipervínculo

Vista de la vista previa de un archivo Markdown con un hipervínculo

Introducción a los conceptos de GitHub

Hipervínculos

Vista animada haciendo clic en un hipervínculo

Introducción a los conceptos de GitHub

Imágenes

Vista animada arrastrando una imagen al archivo Markdown y GitHub generando la sintaxis automáticamente

Introducción a los conceptos de GitHub

Escribir un README

  • Debe ser descriptivo
    • Cualquiera debería entender el proyecto
  • Lista el contenido del repositorio
  • Explica el proyecto con claridad

Ilustración de un libro abierto

Introducción a los conceptos de GitHub

Fundamentos del README

  • Título
  • Descripción de la tecnología
    • ¿Por qué?
  • Descripción del proceso
    • ¿Por qué?
  • Tabla de contenidos
Introducción a los conceptos de GitHub

Extras del README

  • Cómo surgió el proyecto
  • La motivación
  • Limitaciones
  • Desafíos
  • Qué problema busca resolver
  • Uso previsto
  • Créditos
Introducción a los conceptos de GitHub

¡Vamos a practicar!

Introducción a los conceptos de GitHub

Preparing Video For Download...