A importância de um bom README em seus projetos
Você sabia que um README bem estruturado🧱 pode dar um boom em seu(s) projeto(s)?🎇📌🔥
O melhor de tudo isso é que o Github tem um artigo que vai desde a formatação inicial até formatação avançada - criação de mapas, diagramas e etc. 📊📉
E tem mais!!!
Se você quiser fazer seu README e ver o preview instantaneamente no site readme.so (Clique para visitar o site).
#Github #README
Isso é verdade.
Um bom READ.ME deixa bem explícito sobre uma versão geral do seu projeto, respondendo algumas das várias perguntas daqueles que visitam para vê-lo: O que é esse projeto? Qual problema ele resolve? Como ele é estruturado? Como posso executá-lo na máquina local? Quais tecnologias ele utiliza (Exemplo: Java/Spring Boot para o back-end; PostgreSQL para banco de dados, Maven para dependências, CloudFlare R2 para armazenamentos de arquivos, ...)?
Além disso, ele também serve tanto para guiar o próprio criador deste projeto após passar muito tempo sem modificá-lo quanto para inspirar o mesmo para desenvolver outros projetos que precisaria das configurações semelhantes ou iguais.