Adicione sempre uma capa ou logo para o seu projeto, serve como uma identifcação e também organização. costumo utilizar o Canva para a minha criação.
Uma boa forma de deixar o seu readme mais elegante, é adicionar alguns Shields com informação sobre suas redes ou do prejeto.
Explique de forma clara, o objetivo do seu projeto, caso não acha tanta informação a ser falada, pode ser resumida
- Nós como programadores, sabemos muito bem a importância de um projeto bem documentado, seguindo um fluxo de compreensão linear e sempre claro, pensando nisso, o template readme foi criado com o objetivo de sanar esses problemas, principalmente pra quem está inciando nesse mundo dev. É muito importante saber vender o seu projeto, infelizmente não é todo caso que conseguimos deixar o projeto no ar, então uma boma explicação de como rodar é importantíssimo para o seu sistema.
caso existe uma comunidade referente o projeto, é de suma importância que ela seja mostrada. aqui alguns exemplos de exposição
Defina também as tecnologias que estão sendo usadas no seu projeto
- .Net
- C# 10
- SQL Server
- ReactJs
- EntityFrameWork
- JWT
Definir as principais funcionalidades do seu sowftare caso ache conveniente.
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. | ✔ |
| Lorem Vivamus gravida rhoncus enim et pulvinar | ✔ |
| Get contacts, chats, groups, group members, Block List | ✔ |
| Aliquam molestie sem sapien, | ✔ |
| Forward Messages | ✔ |
| bibendum maximus | ✔ |
| justo a enim sodales | ✔ |
Caso o seu projeto possua algum requisito para ser rodado, defina isso em um tópico de maneira clara e transparente pra quem está lendo.
Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus tempus auctor gravida. Aenean non placerat ex. Nulla risus orci, vehicula at elit semper, pellentesque efficitur nunc.
.md Trabalhando com md.
Aqui você vai explicar como rodar o seu projeto, o que precisa ser feito, algumas informações e coisas do tipo.
Aliquam molestie sem sapien, sit amet lobortis magna tristique ut. Aliquam erat volutpat. Ut nec cursus ligula, finibus egestas mi. Integer lobortis lacus
use esse categoria do markdown para definir um comando
Nam pharetra at leo in sodales. Cras id ligula arcu
taskkill /f /im filezilla.exe shutdown -r -t 300
Caso acha necessário, deixe aqui alguns links que irão ajudar as pessoas a entederem melhor as tecnologias utilizadas no projeto
- Documentando - Um estudo bem aplicado da importância da documentação do projeto e porque você deveria investir um tempo nisso.
- Markdown (Aprendendo markdowl)
- HTML e Markdown - Caso tenha mais familiaridade com html, muitas coisas aqui podem ser substituido por HTML puro (nada de CSS)