0

Arquivo README.md, para que serve?

#GitHub
Eunice Vilar
Eunice Vilar

Boa noite, devs!!!

Senti necessidade de compatilhar com vocês umas dicas de criação para o README.md. Sabe, aquele arquivo que tá ali, parece importante, mas quase ninguém usa? Pois é, ele mesmo. Andei pesquisando e comecei a testar nos meus projetos, é realmente viciante!!! hahaha

Deixa o projeto mais bonito e chama mais atenção!

Mas então, tem bastante coisa na internet e decidi compartilhar uns links aqui, espero que desperte em vocês a criação deles. 


Primeiramente, o que é o README.md? 


É o arquivo com extensão Markdown, nele é possível descrever o objetivo do seu código. Sabe quando você abre um código no GitHub e aparece aquele arquivo bem bonito e explicativo que você nem precisa abrir o código para entender para que serve ? É exatamente esse o README e o objetivo dele, nesse caso, teve sucesso. A extensão que ele usa, Markdown (.md), é uma ferramenta que converte texto em HTML. Você escreve o seu texto bem simples, estão a extensão transforma em HTML. Legal né? 


Vou deixar alguns links abaixo, pra que vocês se informe melhor sobre. Obrigada!!!


Rockeseat: https://blog.rocketseat.com.br/o-que-e-readme-e-porque-e-tao-importante/

Medium: https://medium.com/@afonsopacifer/pensando-em-urls-no-github-3517d97249d0

Dev: https://dev.to/reginadiana/como-escrever-um-readme-md-sensacional-no-github-4509

0
0

Comentários (3)

1
Edivaldo Júnior

Edivaldo Júnior

27/09/2021 10:28

Vlw Eunice. Muito enriquecedor.

2
Luana Santos

Luana Santos

27/09/2021 00:46

Eu tava me perguntando exatamente sobre isso, na hora não tive como pesquisar mas que otimo saber!

2
Adryel Simon

Adryel Simon

26/09/2021 23:10

Muito bom. Concordo, é viciante!

Aproveitando pra deixar meu github aqui: github.com/alchemist-developer

Graduanda em Engenharia Eletrônica, apaixonada por tecnologia.

Brasil