README para projetos: saiba como criar
- #GitHub
Ao criar um projeto é interessante ter um README para explicar do que se trata o que você desenvolveu, eu particularmente ainda não organizei o README dos meus projetos por não saber como, então esse artigo também é para o meu conhecimento rs.
----------------------------------------------------------------------------------------------------------------------
Respondendo 3 perguntas já é possível criar um bom README:
1° - O que é o seu projeto?
Um projeto é iniciado para resolver algum problema, qual é esse problema? Destaque o que você fez para resolver, citando as tecnologias e as funcionalidades, se foi baseado em algum projeto existente, destaque as melhorias, correções que foram realizadas.
2° - Como executar o seu projeto?
O projeto está no ar? Já está hospedado em algum domínio? Caso sim, adicione o site. Caso não, crie um passo a passo de como o usuário pode rodar o projeto em sua máquina.
3° - Como utilizar o projeto?
Dependendo do nível de complexidade do seu software, é legal adicionar um tutorial de como usar a aplicação, especificando o que o usuário deve fazer para que atenda a sua necessidade.
----------------------------------------------------------------------------------------------------------------------
Dicas adicionais
Até aqui, ao responder as perguntas, adiciona-se somente texto no README, porém caso seu objetivo seja chamar atenção de algum gestor da área ou então de um recrutador adicionar gif e/ou imagens é necessário para manter a pessoa curiosa sobre o projeto, e de preferência, devem estar no início do README.
Por fim deixo aqui um site que encontrei para facilitar a criação do README com base nas informações que passei aqui nesse artigo:
https://readme-maker.herokuapp.com/
Espero que tenha conseguido entender um pouco mais sobre como criar seu README para projetos, se tiver alguma dúvida, crítica ou correção, por favor deixe nos comentários.
Referência: https://www.youtube.com/watch?v=zeX9YRynyBQ
