Readme.txt vs. README.txt (Português)

Todas as letras maiúsculas se destacam e tornam o arquivo facilmente visível, o que faz sentido porque é provavelmente a primeira coisa que um novo usuário gostaria de ver. (Ou, pelo menos, deveria ter olhado …) Como outros já disseram, os nomes de arquivo que começam com uma letra maiúscula serão listados antes dos nomes em minúsculas em Classificação ASCIIbética (LC_COLLATE=C) que ajuda a tornar o arquivo visível à primeira vista.

O README file é parte de um grupo de arquivos que um usuário de um pacote de software livre normalmente espera encontrar. Outros são INSTALL (instruções para criar e instalar o software), AUTHORS (lista de contribuidores), COPYING (texto da licença), HACKING (como começar a contribuir, talvez incluindo uma lista TODO de pontos de partida), NEWS (mudanças recentes) ou ChangeLog (principalmente redundante com sistemas de controle de versão).

Isso é o que GNU Coding Standards tem a dizer sobre o arquivo README.

A distribuição deve conter um arquivo denominado README com uma visão geral do pacote:

• o nome do pacote;
• o número da versão do pacote ou consulte onde a versão do pacote pode ser encontrada;
• uma descrição geral do que o pacote faz;
• uma referência ao arquivo INSTALL, que deve entrar n contém uma explicação do procedimento de instalação;
• uma breve explicação de quaisquer diretórios ou arquivos incomuns de nível superior ou outras dicas para os leitores encontrarem seu caminho em torno da fonte;
• a referência ao arquivo que contém as condições de cópia. A GNU GPL, se usada, deve estar em um arquivo chamado COPYING. Se o GNU LGPL for usado, ele deve estar em um arquivo chamado COPYING.LESSER.

Como é sempre bom se esforçar para causar a menor surpresa de seus usuários, você deve seguir essa convenção, a menos que haja motivos convincentes para um desvio. No mundo UNIX, as extensões de nome de arquivo eram tradicionalmente usadas com moderação, então o nome canônico do arquivo é README sem nenhum sufixo. Mas a maioria dos usuários provavelmente não teria problemas para entender que um arquivo chamado README.txt tem o mesmo significado. Se o arquivo estiver escrito em Markdown , um nome de arquivo como README.md também pode ser razoável. Evite usar linguagens de marcação mais complicadas como HTML no arquivo README, no entanto, porque deve ser conveniente ler em um terminal somente texto. Você pode indicar aos usuários o manual do software ou sua documentação on-line, que pode ser escrito em um formato mais sofisticado, para obter detalhes do arquivo README.

Tradicionalmente, o arquivo era chamado README em maiúsculas porque os ambientes de linha de comando que usam a ordem alfabética colocariam o arquivo no topo. Isso os torna facilmente visíveis em grandes diretórios.

É provavelmente um resquício do mundo Unix / Linux, onde você baixaria os fontes e, em seguida, construiria seu software. Ter arquivos como README e INSTALL no topo de sua visualização “listar o conteúdo do diretório” torna isso mais fácil ver que eles estão lá, em vez de ter que navegar por todo o conteúdo a partir de uma interface de linha de comando. O mesmo princípio básico funciona para o github também (e também funciona em interfaces GUI, pensando bem, então pode ainda tem mérito)

De forma alguma é uma regra rígida, mas muito provavelmente algo que todos estão fazendo por hábito porque outros projetos estão fazendo. A menos que haja alguma razão explícita para NÃO fazer, você provavelmente deve usar todos caps só porque você o verá sendo usado dessa forma em muitos outros projetos. É também a nomenclatura padrão que o Github usa quando você cria um novo repositório.

Comentários

• I ' ve sempre pensei que letras maiúsculas eram uma forma de ênfase, da mesma forma que você tem as seções em letras maiúsculas no idioma jurídico.
• Em uma interface de linha de comando, os arquivos que vão para o topo da lista são, na verdade, aqueles que rolar para fora da exibição primeiro, portanto, às vezes, esses são os arquivos menos visíveis. A menos que você sempre faça algo como ls -l | less.

README é geralmente escrito em maiúsculas. Desta forma, o ls comando Unix colocou o arquivo próximo ao início da listagem do diretório (as letras maiúsculas vêm antes das minúsculas na ordem ASCII).

> Comentários

• Este foi o motivo histórico, mas ls não ' t normalmente classifica dessa forma em sistemas modernos.
• @ dan1111 Certo! Obrigado (apenas para tentar … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)