O arquivo README.md é a primeira impressão de qualquer projeto no GitHub. Ele funciona como um cartão de visitas, explicando o objetivo, funcionalidades e orientações sobre o uso do projeto. A extensão deste arquivo deverá ser .md que significa Markdown, linguagem de marcação, assim como HTML e serve basicamente para estilizarmos texto na web.
Clique aqui para acessar a documentação.
É importante que o arquivo readme.md contenha título do projeto, sobre, tecnologias utilizadas, autores e outros detalhes que forem importantes ao projeto.
Abaixo contem alguns modelos para criar o arquivo reamd.me, e neste link contem um arquivo readme bem detalhado.
<h1>Título do projeto</h1>
# Título do projeto
<h2>�� Sobre</h2>
<p>Projeto utilizado...</p>
## �� Tecnologias
<div>
<img src="">
<img src="https://img.shields.io/badge/CSS-239120?&style=for-the-badge&logo=css3&logoColor=white">
</div>
# Tempo
| [ < img loading = " lazy " src = " https:// " width = 115 >< br >< sub >Nome Sobrenome</ sub > ] ( https://github.com/ ) | [ < img loading = " lazy " src = " https:// " width = 115 >< br >< sub >Nome Sobrenome</ sub > ] ( https://github.com/ ) |
| :---: | :---: |
Carregar arquivo readme
Podemos abrir uma caixa de texto e inserir no repositório do github ou criar um arquivo readme.md dentro do vscode;=.
Neste link contem mais detalhes interessantes: https://www.alura.com.br/artigos/escrever-bom-readme