Sobre | Importante | Nomenclatura | Autor

Sobre

Trata-se de um arquivo escrito em plain text, e deve ou deveria ser o primeiro a ser lido pelo usuário.
Nele contém informações necessárias para entender o projeto (motivação, história, tecnologias usadas, etc)
Um arquivo README pode ser escrito por qualquer editor de texto.

Importante

• INSTALL: Instruções de instalação
• CHANGELOG: Um histórico técnico e detalhado com mudanças de cada versão.
• NEWS: Um histórico de versão simples para o usuário
• LICENSE: Copyright do projeto
• AUTHORS: Créditos do projeto
• CONTRIBUING: Diretrizes e práticas a serem adotadas por contribuidores

Nomenclatura:

O ideal é deixar o nome todo em maiúsculo:

• Em maiúsculo, para que se destaque
• Sistemas UNIX listam em order ASCII (LC_COLLATE=C) onde "R" vem primeiro
• Outros arquivos seguem o mesmo esquema (CHANGELOG, LICENSE, etc)

Links úteis para README:

• https://pandao.github.io/editor.md/en.html
• https://readme.so/pt
• https://shields.io/
• https://banner.godori.dev/
• https://carbon.now.sh/
• https://howtostartanllc.com/logo-maker

Autor

Claudinei Ferreira de Jesus