Origem do "Leiame"

32

Quando as pessoas começaram a escrever arquivos Leia-me?

Parece que praticamente todos os programas possuem esse arquivo, independentemente do formato.

Existe algum primeiro uso documentado deste documento?

documentation terminology history Mahmoud Hossam
fonte
19
Existe alguma primeiro uso documentado de documentação de software ...?
videiras
1
@vines software documentation! = Leiame
Mahmoud Hossam
Mas o Leiame pertence a.
videiras
2
@ videiras Tenho certeza de que a documentação do software precede a convenção de usar um arquivo leia-me.
Mahmoud Hossam

Respostas:

21

Não conheço um primeiro uso canônico. O arquivo Jargon descreve o README como:

Introdução do olho do hacker tradicionalmente incluída no diretório de nível superior de uma distribuição de origem Unix

Então, eu olhei através de algumas árvores de origem do unix, cortesia da The Unix Tree (fornecida pela Unix Heritage Society e pelo Unix Archive ). Alguns arquivos LEIA-ME encontrados nos unices iniciais incluem:

Portanto, avanços em julho de 1977 são bem-vindos!

Tom Anderson
fonte
1
Ele vai além do ITS, infelizmente é bastante difícil encontrar algo realmente marcado na data da última modificação, em comparação à data em que foi arquivado. O primeiro README provavelmente foi criado no final dos anos 60, mas provar que é uma tarefa e tanto.
Tim Post
@ Tim - um README em uma pilha de cartões perfurados!
Martin Beckett
Eu encontrei um de novembro de 1974 e março 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/...
Hugo
10

Tomei uma aula de Sistemas Operacionais este ano passado e lembro que meu professor me disse que eles tinham README (arquivos físicos reais impressos) para todos os seus cartões perfurados e fita magnética e praticamente qualquer outra coisa que fosse um "programa". Naquele momento, você realmente precisava de um por causa do processo trabalhoso envolvido na criação, execução e tudo mais. Às vezes, esses READMEs também incluíam as impressões reais de como os cartões perfurados deveriam ser perfurados como uma forma de verificação e depuração de erros.

Aparentemente, a convenção também segue o sistema antigo, em que, com todos os cartões perfurados, um "reem" de papel foi anexado com a declaração README em maiúsculas impressa, com todas as instruções de uso e carregamento dos cartões perfurados no sistema .

Para uma referência temporal, isso teria sido nos anos 60. Mas o sistema de cartões perfurados existe desde os anos 1700 para controlar teares "automatizados", talvez até tão antigos quanto isso.

Jeff Langemeier
fonte
8

Encontrado através deste tópico alt.folklore.computers :

Aposto que alguns documentos que acompanham um dos sistemas operacionais PDP-8 ou pacotes de software provavelmente serão os mais antigos.

O mais antigo que encontrei nos arquivos do PDP-10 é o UCI LISP " READ.ME " da 4ª fita da biblioteca DECUS, com um carimbo de data / hora de 27 de março de 1975 :

http://pdp-10.trailing-edge.com/decuslib10-04/index.html

Infelizmente, muitos dos mini-SOs anteriores não oferecem suporte a um carimbo de data / hora [único] na estrutura de diretórios de fita e / ou disco; portanto, é difícil saber quando um documento foi realmente editado pela última vez.

O arquivo não apenas possui um carimbo de data / hora de 27 de março de 1975, como também é assinado e datado no próprio arquivo :

                    UCI LISP

                    Random Notes

                    [...]

  Should  problems  arise  with   this   system,  please
  communicate  them  to  the  Department  of  Information and
  Computer Science at UCI;  they will be directed to whomever
  is currently managing the UCI LISP system.

            William J. Earl
            Department of Information and Computer Science
            University of California
            Irvine, California

            27 March 1975

Edit: navegando pelos arquivos do PDP-10, encontrei um README.TXT anterior de 27 de novembro de 1974, com carimbo de data e hora e assinado no arquivo :

[README.TXT é o arquivo DOC para SPICE / SINC / SLIC]

Esta fita à prova de falhas contém os programas de análise de circuitos:

    SPICE SINC and SLIC

descrito no Boletim de Software Aplicativos Volume 4.

requisitos:

O SPICE requer o FORTRAN-10 versão 4, devido ao uso de dados Holerith ajustados à direita. Executa em cerca de 47K.

[...]

ele também inclui esse arquivo, as FOROTS para acompanhar os SAVes e a fonte para SECOND.MAC, a rotina de temporização. O SPICE é dividido em três partes: 1SPICE.FOR, 2 e 3.

Há um documento impresso para descrever cada um dos programas. Eles estão incluídos no pacote DECUS. A documentação e os programas foram desenvolvidos originalmente pelo departamento de EE da Univ. da Califórnia em Berkley em um CDC 6400. Exceto para converter o FORTRAN no DECsystem-10, nenhuma alteração foi feita nos programas. Para os dados de teste SLIC e SINC mostraram uma ligeira variação em relação ao 6400, o SPICE não mostra variação.

Boa sorte! Ashley Grayson 27-NOV-74

[fim do README.TXT]

http://pdp-10.trailing-edge.com/decus_20tap3_198111/01/decus/20-0079/readme.txt.html

Hugo
fonte