Походження програми "Readme"

32

Коли люди почали писати файли Readme?

Здається, що майже всі програми мають цей файл, незалежно від формату.

Чи є документально підтверджене перше використання цього документа?

documentation terminology history

— Махмуд Хоссам
джерело

19

Чи є якесь документально підтверджене перше використання програмної документації? ...

— виноградники

1

Документація по програмному забезпеченню @vines! = Readme

— Махмуд Хоссам

Але Readme належить.

— лози

2

@vines Я впевнений, що програмна документація передує умові використання файлу readme.

— Махмуд Хоссам

21

Я не знаю канонічного першого використання. Жаргон Файл описує README як:

Введення хакерських очей традиційно включається в каталог верхнього рівня розподілу джерел Unix

Тож я переглянув деякі дерева первинних джерел Unix, люб’язно надавши Дерево Unix (надане Товариством спадщини Unix та архівом Unix ). Деякі файли README, знайдені в попередніх програмах, включають:

/ sys / source / lex / README від PWB 1.0 (липень 1977 р.) - найдавніший, який я міг знайти
/ usr / doc / README з сьомого видання (січень 1979 р.) - найдавніше, що я міг знайти для всього дерева джерел
/ usr / doc / README від 3BSD (березень 1980 р.) - найдавніший, який я міг знайти для BSD

Отже, аванси на липень 1977 р. Вітаються!

— Том Андерсон
джерело

1

Це виходить за межі ІТС, на жаль, досить складно знайти щось фактично відмічене в часі на дату його останньої зміни, порівняно з датою її архіву. Перша README, ймовірно, була створена наприкінці 1960-х, але довести, що це досить завдання.

— Tim Post

@Tim - ПРОЧИТИ на стопі перфокарт!

— Мартін Бекетт

Я знайшов його з листопада 1974 р. Та березня 1975 р.: Programer.stackexchange.com/questions/96966/origin-of-readme/…

— Гюго

10

Цього року я взяв клас «Операційні системи» і пам’ятаю, як мій професор сказав мені, що вони мали README (фактичні фізичні друковані файли) для всіх своїх перфокарт та магнітофонних стрічок і майже нічого іншого, що було «програмою». У той час тобі справді потрібен був той, що був працездатним процесом, пов'язаним із отриманням створеного, бігом та всього іншого. Ці README іноді також включали фактичні роздруківки того, як повинні бути пробиті перфокарти як форми перевірки помилок та налагодження.

Конвенція, мабуть, також слідує за старою системою в тому, що з усіма перфокартами було додано "reem" паперу з випискою README у надрукованих на ній ковпаках, в ньому були всі інструкції щодо використання та завантаження перфокарт в систему .

Для довідок, це було б у 60-х. Але система перфокарт існує вже з 1700-х рр. Для контролю «автоматизованих» ткацьких верстатів, тож, можливо, навіть такої старої.

— Джефф Лангмейер
джерело

8

Знайдено за допомогою цієї теми alt.folklore.com :

Я ставлю на облік якийсь документ, що супроводжує одну з операційних систем PDP-8 або програмний пакет, мабуть, буде найдавнішим.

Найдавніший, який я знайшов в архівах PDP-10, - це UCI LISP " READ.ME " з 4-ї бібліотечної стрічки DECUS із часовою позначкою 27 березня-1975 :

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

На жаль, багато хто з попередніх міні-операційних систем не підтримують [унікальну] часову позначку в структурі каталогів стрічки та / або диска, тому важко сказати, коли документ справді був остаточно відредагований.

Не тільки файл має часову позначку від 27 березня 1975 року, але він підписується та датується у самому файлі :

                    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

Редагувати: переглядаючи архіви PDP-10. Я знайшов більш ранню README.TXT від 27 листопада 1974 року, як мітка часу , так і підписаний у файлі :

[README.TXT - файл DOC для SPICE / SINC / SLIC]

Ця несправна стрічка містить програми аналізу ланцюга:
    SPICE SINC and SLIC
описано в Бюлетені програмного забезпечення «Том 4».

вимоги:

SPICE вимагає FORTRAN-10 версії 4, оскільки вона використовує правильно налаштовані дані Холерита. Виконує приблизно в 47 к.

[...]

він також включає цей файл, ФОРОТИ, які потрібно відправляти з SAVes, та джерело для SECOND.MAC, порядок часу. SPICE розбивається на три частини: 1SPICE.FOR, 2 і 3.

Існує друкований документ для опису кожної з програм. Вони включені в пакет DECUS. Документацію та програми спочатку розробляв відділ ЗНО Університету. Каліфорнії в Берклі на CDC 6400. За винятком конвертації FORTRAN в DECsystem-10 жодних змін в програмах не було. Для тестових даних SLIC та SINC показали незначні зміни щодо 6400, SPICE не показує змін.

Удачі! Ешлі Грейсон 27-НОВ-74

[кінець README.TXT]

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

— Гюго
джерело