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
Muito bom. Parabéns pelo artigo
Valeu mesmo Ualace!
Vou elogiar novamente, esse artigo foi o melhor que já vi aqui até hoje, Matheus, você é muito diferenciado. Obrigado novamente
Parabéns, Matheus Coimbra, seu artigo é excelente e exatamente o que estava buscando para melhorar meus Readme.
Obrigado pelo feedback pessoal!
Oi Michele! To por aqui nos artigos também de forma semanal, sempre que surge algo em mente rs, obrigado por complementar com o link do repositório, de muita utilidade!
Eu estou iniciando no mundo do GitHub e isso vai me ajudar e muito a organizar e comentar meus projetos, obrigado o/
Muito bom, há um tempo tenho pensado em colocar um readme nos meus projetos, mas vou deixando para depois. Vou dar uma olhada nessas dicas e por em prática.
Otimas dicas, muito obrigado, vou começar a aderir agora mesmo.
Legal, Matheus!! Vlw!!
Oi Matheus!
Eu já te ‘conheço’ de ver suas mensagens lá no bootcamp de Java/iFood. Bacana vê-lo aqui na área de artigos também! : )
Então: depois de ler teu texto, queria deixar um link de um repositório bem legal no próprio GitHub chamado Awesome README, em que um rapaz faz a curadoria de vários READMEs criativos, bem-feitos, bem-escritos, etc., o que acho que é sempre uma inspiração inicial para como planejarmos esta tarefa e tem tudo a ver com a proposta do teu artigo!
Link do repositório: https://github.com/matiassingers/awesome-readme
Muito bom, todos precisamos adotar essas boas práticas para nossos repositórios.