Происхождение «Readme»

32

Когда люди начали писать файлы Readme?

Кажется, что почти во всех программах есть этот файл, независимо от формата.

Есть ли документированное первое использование этого документа?

documentation terminology history Махмуд Хоссам
источник
19
Есть ли документированное первое использование документации по программному обеспечению? ...
лозы
1
@vines документации по программному обеспечению! = Readme
Махмуд Хоссам
Но Readme принадлежит.
виноградные лозы
2
@vines Я уверен, что документация по программному обеспечению предшествует соглашению об использовании файла readme.
Махмуд Хоссам

Ответы:

21

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

Представление Hacker's Eye традиционно включается в каталог верхнего уровня исходного дистрибутива Unix

Итак, я посмотрел некоторые ранние исходные деревья Unix, любезно предоставленные The Unix Tree (предоставленные Unix Heritage Society и Unix Archive ). Некоторые файлы README, найденные в ранних версиях, включают:

  • / sys / source / lex / README из PWB 1.0 (июль 1977 г.) - самое раннее, что я смог найти
  • / usr / doc / README из седьмого издания (январь 1979 г.) - самое раннее, что я смог найти для всего дерева исходных текстов
  • / usr / doc / README из 3BSD (март 1980 г.) - самое раннее, что я смог найти для BSD

Итак, успехи в июле 1977 года приветствуются!

Том Андерсон
источник
1
Это выходит за рамки ITS, к сожалению, довольно сложно найти что-то, на самом деле отмеченное временем на дату его последнего изменения, против даты, когда оно было заархивировано. Первый README, вероятно, был создан в конце 1960-х годов, но доказать, что это довольно сложная задача.
Тим Пост
@Tim - README на стопке перфокарт!
Мартин Беккет
Я нашел один из ноября 1974 года и марта 1975 года: programmers.stackexchange.com/questions/96966/origin-of-readme/…
Гюго
10

В прошлом году я посещал урок «Операционные системы» и помню, как мой профессор говорил мне, что у них есть README (реальные физические печатные файлы) для всех перфокарт и магнитной ленты, и почти все остальное, что было «программой». В то время вы действительно нуждались в нем из-за трудоемкого процесса, связанного с получением созданного, запущенного и всего остального. Эти README иногда также включали фактические распечатки того, как перфокарты должны были быть перфорированы как форма проверки ошибок и отладки.

Соглашение, очевидно, также следует старой системе в том смысле, что ко всем перфокартам был прикреплен «лист бумаги» с заявлением README в заглавных буквах, на котором были все инструкции по использованию и загрузке перфокарт в систему. ,

Для справки, это было бы в 60-х годах. Но система перфокарт существует с 1700-х годов для управления «автоматизированными» станками, так что, может быть, даже такой старой.

Джефф Лангемайер
источник
8

Найдено в этой ветке alt.folklore.computers :

Бьюсь об заклад, некоторые документы, сопровождающие одну из операционных систем 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 из-за использования данных Holerith, настроенных справа. Выполняется примерно за 47К.

[...]

он также включает этот файл, FOROTS для сохранения и источник SECOND.MAC, подпрограмму синхронизации. SPICE разбит на три части: 1SPICE.FOR, 2 и 3.

Существует печатный документ для описания каждой из программ. Они включены в пакет DECUS. Документация и программы были первоначально разработаны отделом EE Univ. Калифорния в Беркли на 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

Хьюго
источник