0

Por quê e como criar um README.md

Leonardo Alves
Leonardo Alves

Boa tarde!!

Outro dia estava pesquisando algumas coisas e caí no blog da Rocketseat de "O que é um README e porque é tão importante", já deixei o link mas vou resumir um pouco.


Basicamente um README.md (Leia-me) é uma forma de você explicar o que tem no seu código. Ele serve pra duas coisas principais:

  • Mostrar para um recutador como ele funciona e aumentar as suas chances de ser contradado
  • Ajudar seu time a entender o que você fez e como
  • Se lembrar de onde parou ou o rever que você já fez e tem


O sufixo "md" significa Markdown (link para um guia básico) que é basicamente um HTML mais simples, você pode escolher em qual dos dois vai escrever. Então se você já sabe HTML você já vai conseguir utilizar muito bem o README, se não não tem problema mas estudar sempre é uma boa.


Agora que você sabe o que é um README vou te dar uma breve explicação de como fazer ele e como sempre vou deixar o link para uma aprofundada a mais, um do blog da rocketseat e outro da onebitcode.




Título e descrição

Começando pelo título que é o nome da aplicação, a primeira coisa que a pessoa que tá lendo vai ver e em seguida uma descrição de como ele funciona.


Status

Eu particularmente deixo o status do projeto apenas quando ele não está finalizado.


Demonstração

Muito importante deixar uma demonstração da aplicação, seja front-end, back-end, mobile, enfim. Deixar a demonstração vai economizar o tempo de download, instalação, utilização, e tudo mais que a pessoa que está vendo vai fazer.

Dica extra, você tem duas opções para fazer isso:

  • Você pode deixar o arquivo hospedado em algum site como imgur ou giphy, o que não é recomendado mas nada te impede disso.
  • Você cria uma pasta específica para colocar os arquivos, deixando bem organizado e facilitando a sua vida.


Tecnologias

Você também pode deixar as tecnologias que você usou na aplicação, facilitando tanto pro recrutador pra entender o que você sabe, quanto pro seu time saber o que você usou.


Autor

Eu não coloquei no meu respositório, pois apenas eu que faço mas colocarei se eu obtiver alguma ajuda.


Licença

Existe uma licença que chama MIT, que é a mais usada pesquise um pouco como ela funciona e já coloque no seu código open source.





E por fim eu vou deixar meu repositório pra vocês darem uma olhada, agradeço qualquer feedback e muito obrigado por ler.

0
0

Comentários (3)

0
Ednei Almeida

Ednei Almeida

23/04/2021 15:36

Parabéns pelo artigo Leonardo, aproveitando, pode avaliar o meu e me dizer se estou no caminho certo?


https://github.com/EdMaxi


1
Pedro Vasconcelos

Pedro Vasconcelos

12/04/2021 17:10

Sim o readme é muito importante, funciona como a documentação do seu projeto, serve também para quem ver o seu projeto entender do que se trata e até pra vc mesmo organizar suas ideias.

Gosto de usar as dicas desse site pra deixar o readme mais agradável visualmente https://raullesteves.medium.com/github-como-fazer-um-readme-md-bonit%C3%A3o-c85c8f154f8

1
William Junior

William Junior

12/04/2021 15:47

Ótimo artigo Leonardo, era exatamente o que eu estava fazendo agora, escrevendo um README. Boa!

Moro em Uberlândia, possuo conhecimento quase intermediário de Java, POO e básicos em Linux, git, C e C++, atualmente aprendendo Kotlin.

Brasil