Ainda não tem acesso? Estude com a gente! Matricule-se
Ainda não tem acesso? Estude com a gente! Matricule-se
Solucionado (ver solução)
Solucionado
(ver solução)
3
respostas

O que é o README ?

Sempre que vou criar um novo repositório tem a opção de já criar esse arquivo... gostaria de saber se é recomendável criar ou tanto faz ?

3 respostas
solução!

Olá Aram, tudo bem?

O arquivo readme.md é utilizado para descrever seu projeto, explicar as características principais, como fazer para funcionar ( uma espécie de resumo ) onde você pode acrescentar diversas informações que você considere útil.

Para projetos pessoais, que provavelmente não serão compartilhados, não é necessário você criar esse arquivo, agora caso você queira compartilhar o seu projeto, ou que quando alguém ao acessar seu repositório tenha conhecimento do que se trata é sempre bom conter esse arquivo :)

Vou dar um exemplo: Observe esse repositório: https://github.com/expressjs/express

Todas essas informações que é possível observar nessa imagem estão presentes dentro do arquivo readme.md, você pode checar clicando aqui

Entendeu?

Abraços e Bons Estudos!

Olá Aram e Geovani! O comentário do Geovani é muito válido, acho que eu poderia adicionar mais uma possibilidade para a utilização README.md, que é utilizá-lo para acompanhamento de projetos, quando estamos desenvolvendo um projeto, seja um sistema, uma API, um site ou qualquer outro projeto, podemos utilizar o markdown para fazermos um documento que mostre o acompanhamento do projeto, o que já foi feito, o que ainda falta fazer entre outros pontos.

Espero ter contribuído!

Muito Obrigado, Geovani e Jonilson agradeço muito e foi de grande ajuda.

Quer mergulhar em tecnologia e aprendizagem?

Receba a newsletter que o nosso CEO escreve pessoalmente, com insights do mercado de trabalho, ciência e desenvolvimento de software