Criando um README

Introdução aos Conceitos do GitHub

Jasmin Ludolf

Content Developer, DataCamp

Editar o README

Visão do repositório de análise de futebol

Introdução aos Conceitos do GitHub

Editar o README

Visão do repositório de análise de futebol com o arquivo README destacado

Introdução aos Conceitos do GitHub

Editar o README

Visão do repositório de análise de futebol com o ícone de lápis para editar o README destacado

Introdução aos Conceitos do GitHub

Markdown

Visualização do arquivo README

Introdução aos Conceitos do GitHub

Editar vs. Prévia

Visualização do arquivo README destacando as abas de edição e prévia

Introdução aos Conceitos do GitHub

Títulos

Visualização da página de edição de markdown com a sintaxe do maior título

Visualização da prévia de markdown com o maior título

Introdução aos Conceitos do GitHub

Títulos

Visualização da página de edição de markdown com a sintaxe dos seis tipos de títulos

Visualização da prévia de markdown com os seis tipos de títulos

Introdução aos Conceitos do GitHub

Títulos

Visualização da página de edição de markdown com a sintaxe dos seis tipos de títulos]

Visualização da prévia de markdown com os seis tipos de títulos e setas apontando para as linhas sob título um e título dois

Introdução aos Conceitos do GitHub

Formatação de texto

Visualização da página de edição de markdown com sintaxe para negrito e itálico

Visualização da prévia de markdown com texto em negrito e itálico

Introdução aos Conceitos do GitHub

Hyperlinks

Visualização da página de edição de markdown com sintaxe para um hyperlink

Visualização da prévia de markdown com um hyperlink

Introdução aos Conceitos do GitHub

Hyperlinks

Visualização animada de um clique em um hyperlink

Introdução aos Conceitos do GitHub

Imagens

Visualização animada arrastando uma imagem para o arquivo markdown e o GitHub gerando a sintaxe automaticamente

Introdução aos Conceitos do GitHub

Escrevendo um README

  • Precisa ser descritivo
    • Qualquer pessoa deve entender o projeto
  • Liste o conteúdo do repositório
  • Explique o projeto com clareza

Ilustração de um livro aberto

Introdução aos Conceitos do GitHub

Fundamentos do README

  • Título
  • Descrição da tecnologia
    • Por quê?
  • Descrição do processo
    • Por quê?
  • Sumário
Introdução aos Conceitos do GitHub

Extras do README

  • Como o projeto surgiu
  • Motivação
  • Limitações
  • Desafios
  • Que problema quer resolver
  • Uso pretendido
  • Créditos
Introdução aos Conceitos do GitHub

Vamos praticar!

Introdução aos Conceitos do GitHub

Preparing Video For Download...