Personalize o README no GitHub.

#GitHub

O README é um arquivo com extensão .md (markdown) e deve apresentar informações necessárias para compreender o objetivo do projeto. Dessa forma, ter um README personalizado facilita na organização e visualização dos projetos no GitHub.

Para criar um bom README é necessário que a estrutura do seu arquivo tenha um título, uma descrição (na qual geralmente são adicionados links) e imagem ou gif para ajudar na visualização do projeto e sair da abstração.

A sintaxe markdown converte o texto em HTML e possui caracteres não-alfabéticos, como #, \* e ![](), usados para a configuração de títulos, listas, itálico, negrito e inserção de imagens.

Lista de comandos em Markdown:

Titulação

# corresponde ao <h1>

## corresponde ao <h2>

### corresponde ao <h3>

#### corresponde ao <h4>

##### corresponde ao <h5>

###### corresponde ao <h6>

Ênfase

Negrito: adicione dois asteriscos (**) ou dois traços baixos (__) no início e final do texto que se deseja deixar negrito.

Itálico: adicione um asterisco (*) ou um traço baixo (_) no início e final do texto que se deseja deixar itálico.

Links

Para adicionar link é necessário utilizar os caracteres []() ou <>.

Exemplo 1: [Recriando o jogo da cobrinha com JavaScript](https://web.dio.me/project/recriando-o-jogo-da-cobrinha-com-javascript/learning/bfcd37b9-4ccf-40fb-b0ea-c2d865414a19?back=/track/html-web-developer&tab=undefined&moduleId=undefined) , nesse caso o que aparecerá no arquivo é o que está entre chaves e o endereço de destino está entre parênteses.

Exemplo 2: <https://web.dio.me/project/recriando-o-jogo-da-cobrinha-com-javascript/learning/bfcd37b9-4ccf-40fb-b0ea-c2d865414a19?back=/track/html-web-developer&tab=undefined&moduleId=undefined> , nesse caso o link será direto e aparecerá no README.

Imagens ou gifs

Para adicionar imagens ou gifs no README é necessário colocar o arquivo .png, .jpeg ou .gif desejado em uma pasta dentro do repositório do GitHub.

Digamos que a pasta onde o arquivo.gif está se chama "img" e está dentro de outra pasta intitulada "assets", então para colocar o arquivo no README:

Existem outras formas de realizar esses comandos, uma vez que nada na área de tecnologia possui somente uma maneira de ser resolvida. Se você conhece outra forma ou até mesmo um jeito mais prático de realizá-los, comenta aqui pra a gente trocar conhecimento! :D

Espero ter ajudado quem tem dúvidas nessa parte do README.md.

Referências:

Como fazer um bom README. Disponível em: <https://blog.rocketseat.com.br/como-fazer-um-bom-readme/>

O que é README e porque é tão importante. Disponível em: <https://blog.rocketseat.com.br/o-que-e-readme-e-porque-e-tao-importante/>

Guia básico de Markdown. Disponível em: <https://docs.pipz.com/central-de-ajuda/learning-center/guia-basico-de-markdown#open>