Asal "readme"

32

Kapan orang mulai menulis file Readme?

Tampaknya hampir semua program memiliki file ini, apa pun formatnya.

Apakah ada penggunaan pertama dokumen ini yang didokumentasikan?

documentation terminology history

— Mahmoud Hossam
sumber

19

Apakah ada dokumentasi pertama yang menggunakan dokumentasi perangkat lunak? ...

— vines

1

dokumentasi perangkat lunak @vines! = Readme

— Mahmoud Hossam

Tapi Readme milik.

— tanaman merambat

2

@vines Saya yakin dokumentasi perangkat lunak mendahului konvensi menggunakan file readme.

— Mahmoud Hossam

21

Saya tidak tahu penggunaan kanonik pertama. The Jargon Berkas menjelaskan README sebagai:

Pengenalan mata hacker secara tradisional termasuk dalam direktori tingkat atas dari distribusi sumber Unix

Jadi saya telah melihat melalui beberapa pohon sumber unix awal, milik The Unix Tree (disediakan oleh Unix Heritage Society dan Arsip Unix ). Beberapa file README ditemukan di unices awal termasuk:

/ sys / source / lex / README dari PWB 1.0 (Juli 1977) - paling awal yang bisa saya temukan
/ usr / doc / README dari Seventh Edition (Jan 1979) - paling awal yang bisa saya temukan untuk seluruh pohon sumber
/ usr / doc / README dari 3BSD (Maret 1980) - paling awal yang bisa saya temukan untuk BSD

Jadi, kemajuan pada Juli 1977 disambut!

— Tom Anderson
sumber

1

Kembali melampaui ITS, sayangnya agak sulit untuk menemukan sesuatu yang sebenarnya dicap waktu pada tanggal terakhir dimodifikasi, vs tanggal itu diarsipkan. README pertama kemungkinan dibuat pada akhir 1960-an, tetapi membuktikan bahwa itu adalah tugas yang cukup.

— Tim Post

@Tim - README di atas tumpukan kartu punch!

— Martin Beckett

Saya menemukan satu dari November 1974 dan Maret 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/…

— Hugo

10

Saya mengambil kelas Sistem Operasi tahun lalu dan ingat profesor saya memberi tahu saya bahwa mereka memiliki README (file cetak fisik aktual) untuk semua kartu punch dan kaset mag dan hampir semua hal lain yang merupakan "program". Pada saat itu Anda benar-benar membutuhkannya karena proses yang melelahkan yang melibatkan pembuatan, berlari, dan yang lainnya. README ini terkadang juga menyertakan cetakan aktual tentang bagaimana kartu punch seharusnya dipukul sebagai bentuk pengecekan kesalahan dan debugging.

Konvensi tersebut rupanya juga mengikuti sistem lama karena dengan semua kartu punch sebuah "reem" kertas dilampirkan dengan pernyataan README dalam topi yang dicetak di atasnya, ini memiliki semua instruksi untuk menggunakan dan memuat kartu punch ke dalam sistem .

Untuk referensi waktu, ini akan menjadi 60-an. Tetapi sistem kartu berlubang sudah ada sejak 1700-an untuk mengendalikan alat tenun "otomatis", jadi mungkin bahkan setua itu.

— Jeff Langemeier
sumber

8

Ditemukan melalui utas alt.folklore.computers ini :

Saya bertaruh beberapa dokumen yang menyertai salah satu sistem operasi PDP-8 atau paket perangkat lunak mungkin akan menjadi yang tertua.

Arsip tertua yang saya temukan di arsip PDP-10 adalah UIS LISP " READ.ME " dari kaset perpustakaan DECUS ke-4, dengan stempel waktu 27-Mar-1975 :

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

Sayangnya, banyak dari OS mini sebelumnya tidak mendukung stempel waktu [unik] dalam pita dan / atau struktur direktori disk, sehingga sulit untuk mengetahui kapan dokumen benar-benar diedit terakhir kali.

File ini tidak hanya memiliki stempel waktu 27 Maret 1975, tetapi juga dengan mudah ditandatangani dan diberi tanggal dalam file itu sendiri :

                    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

Sunting: menjelajah Arsip PDP-10 Saya menemukan README.TXT sebelumnya dari 27 November 1974, baik stempel waktu dan masuk file :

[README.TXT adalah file DOC untuk SPICE / SINC / SLIC]

Rekaman yang gagal ini berisi program analisis rangkaian:
    SPICE SINC and SLIC
dijelaskan dalam Buletin Perangkat Lunak Aplikasi Volume 4.

Persyaratan:

SPICE memerlukan FORTRAN-10 versi 4 karena penggunaan data Holerith yang disesuaikan dengan Hak. Menjalankan sekitar 47K.

[...]

itu juga termasuk file ini, FOROTS untuk pergi dengan SAVes dan sumber untuk SECOND.MAC, rutin waktu. SPICE dibagi menjadi tiga bagian: 1SPICE.FOR, 2 dan 3.

Ada dokumen cetak untuk menggambarkan masing-masing program. Ini termasuk dalam paket DECUS. Dokumentasi dan program awalnya dikembangkan oleh departemen EE Univ. dari Calif. at Berkley pada CDC 6400. Kecuali untuk mengubah FORTRAN ke DECsystem-10 tidak ada perubahan yang dilakukan pada program. Untuk data uji SLIC dan SINC telah menunjukkan sedikit variasi sehubungan dengan 6400, SPICE tidak menunjukkan variasi.

Semoga berhasil! Ashley Grayson 27-NOV-74

[akhir README.TXT]

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

— Hugo
sumber