Readme: diferenças entre revisões
→Introdução: README.md (markdown) |
|||
| Linha 1: | Linha 1: | ||
{{Reciclagem|data=Fevereiro de 2008}} |
{{Reciclagem|data=Fevereiro de 2008}} |
||
== Introdução == |
== Introdução == |
||
Um [[Ficheiro|arquivo]] '''readme''' (também '''read me''', {{lang-pt|leia-me}}) contém informação sobre outros arquivos num diretório ou [[Ficheiro|arquivo]] e é comumente distribuído com [[software]]s de computador. Este arquivo é usualmente um [[arquivo de texto]] chamado <tt>README.TXT</tt>, <tt>README.1ST</tt>, <tt>READ.ME</tt> ou simplesmente <tt>README</tt>, embora softwares como o [[Microsoft Windows]] possam incluir um <tt>README.[[Windows Write|WRI]]</tt>, <tt>README.[[Rich Text Format|RTF]]</tt> ou <tt>README.[[Microsoft Office Word|DOC]]</tt>. |
Um [[Ficheiro|arquivo]] '''readme''' (também '''read me''', {{lang-pt|leia-me}}) contém informação sobre outros arquivos num diretório ou [[Ficheiro|arquivo]] e é comumente distribuído com [[software]]s de computador. Este arquivo é usualmente um [[arquivo de texto]] chamado <tt>README.TXT</tt>, <tt>README.1ST</tt>, README.[[Markdown|MD]], <tt>READ.ME</tt> ou simplesmente <tt>README</tt>, embora softwares como o [[Microsoft Windows]] possam incluir um <tt>README.[[Windows Write|WRI]]</tt>, <tt>README.[[Rich Text Format|RTF]]</tt> ou <tt>README.[[Microsoft Office Word|DOC]]</tt>. |
||
O nome foi escolhido de forma que, mesmo uma pessoa que não sabe o que seria tipicamente um arquivo ''readme'', seria levada a lê-lo em função do nome; além disso, o nome é gravado em caixa alta para que, em ambientes que preservam a diferença entre caixa alta e caixa baixa e usem uma ordenação [[ASCIIbetical]], apareça próximo do início da listagem do diretório (já que, na ordenação ASCIIbetical, caixa alta precede caixa baixa). |
O nome foi escolhido de forma que, mesmo uma pessoa que não sabe o que seria tipicamente um arquivo ''readme'', seria levada a lê-lo em função do nome; além disso, o nome é gravado em caixa alta para que, em ambientes que preservam a diferença entre caixa alta e caixa baixa e usem uma ordenação [[ASCIIbetical]], apareça próximo do início da listagem do diretório (já que, na ordenação ASCIIbetical, caixa alta precede caixa baixa). |
||
| Linha 52: | Linha 52: | ||
== Outros usos == |
== Outros usos == |
||
''Readme'' também é o nome… |
'''''Readme''''' também é o nome… |
||
* …de um festival de arte computacional ([[Aarhus]] 2004, [[Helsinki]] 2003, [[Moscow]] 2002) criado por [[Alexei Shulgin]] e [[Olga Goriunova]], dentre outros. |
* …de um festival de arte computacional ([[Aarhus]] 2004, [[Helsinki]] 2003, [[Moscow]] 2002) criado por [[Alexei Shulgin]] e [[Olga Goriunova]], dentre outros. |
||
* …da coluna de [[Michael Kinsley]] no magazine ''[[Slate (revista)|Slate]]''.* {{link|1=|2=http://www.slate.com/?id=3944&cp=2147|3=www.slate.com}} |
* …da coluna de [[Michael Kinsley]] no magazine ''[[Slate (revista)|Slate]]''.* {{link|1=|2=http://www.slate.com/?id=3944&cp=2147|3=www.slate.com}} |
||
Revisão das 17h24min de 29 de março de 2015
 |
Introdução
Um arquivo readme (também read me, em português: leia-me) contém informação sobre outros arquivos num diretório ou arquivo e é comumente distribuído com softwares de computador. Este arquivo é usualmente um arquivo de texto chamado README.TXT, README.1ST, README.MD, READ.ME ou simplesmente README, embora softwares como o Microsoft Windows possam incluir um README.WRI, README.RTF ou README.DOC.
O nome foi escolhido de forma que, mesmo uma pessoa que não sabe o que seria tipicamente um arquivo readme, seria levada a lê-lo em função do nome; além disso, o nome é gravado em caixa alta para que, em ambientes que preservam a diferença entre caixa alta e caixa baixa e usem uma ordenação ASCIIbetical, apareça próximo do início da listagem do diretório (já que, na ordenação ASCIIbetical, caixa alta precede caixa baixa).
Conteúdo
O conteúdo, tipicamente, inclui uma ou mais dentre as seguintes informações:
- instruções sobre configuração;
- instruções sobre instalação;
- instruções sobre como operar o programa;
- um arquivo de manifesto;
- informação de copyright e licenciamento;
- informação de contato com o distribuidor ou programador;
- defeitos conhecidos;
- troubleshooting;
- créditos e agradecimentos;
- changelog: relato de mudanças.
READMEs sem nome de readme
A expressão "readme file" é também, algumas vezes, usada descritiva e genericamente para arquivos que não possuem nome "readme" mas são considerados espécies de arquivos readmes. A distribuição de código fonte de muitos pacotes de software livre, especialmente aqueles que seguem os Padrões Gnits ou aquele produzidos com a ferramenta GNU Autotools, freqüentemente incluem um conjunto padrão de arquivos readmes:
README Informação Geral AUTHORS Créditos THANKS Agradecimentos ChangeLog Detalhamento das mudanças desde a última versão (changelog), destinado a programadores NEWS Relato básico das mudanças (changelog), destinado aos usuários INSTALL Informações sobre a instalação COPYING Informações sobre licenciamento e Copyright BUGS Defeitos conhecidos e instruções sobre como denunciar novos
Outros arquivos frequentemente distribuídos com software incluem um FAQ e um TODO, este último listando possíveis mudanças futuras.
Outros usos
Readme também é o nome…
- …de um festival de arte computacional (Aarhus 2004, Helsinki 2003, Moscow 2002) criado por Alexei Shulgin e Olga Goriunova, dentre outros.
- …da coluna de Michael Kinsley no magazine Slate.* «www.slate.com»
- …de uma publicação semanal estudantil de humor na Carnegie Mellon University.* «www.activitiesboard.org»