DEV Community

Discussion on: [pt-BR] REDAMEs DO GITHUB: IDEIAS... E DICAS

Collapse
 
eduardoklosowski profile image
Eduardo Klosowski

Eu acho que aprender um pouco de markdown e usar corretamente seus elementos também ajuda. Ou pode ser outra linguagem de marcação como reStructuredText que é mais comum em projetos Python.

Além disso, nem tudo precisa ficar no README, muitas vezes os projetos possuem vários arquivos, como INSTALL dizendo como rodar o projeto, CONTRIBUTE indicando o procedimento de como contribuir com código... Só se organizar.