В распространении и разработке программного обеспечения файл README содержит информацию о других файлах в каталоге или архиве программного обеспечения . Форма документации , обычно это простой текстовый файл , называемый , , , , [1] или (чтобы указать на использование Markdown )READMERead MeREAD.MEREADME.txtREADME.md
Имя файла обычно пишется в верхнем регистре. В частности, в Unix-подобных системах это заставляет его выделяться — как потому, что имена файлов в нижнем регистре более распространены, так и потому, что lsкоманда обычно сортирует и отображает файлы в порядке кодировки ASCII , в котором имена файлов в верхнем регистре будут отображаться первыми. [nb 1]
Файл README обычно включает в себя:
Неясно, когда возникла традиция включать файл README, но были найдены примеры, датируемые серединой 1970-х годов. [3] [4] [5] [6] [7] [8] [9] [ необходим лучший источник ] Раннее системное программное обеспечение Macintosh устанавливало файл Read Me на загрузочный диск, а файлы README обычно сопровождали стороннее программное обеспечение.
В частности, существует долгая история свободного программного обеспечения и программного обеспечения с открытым исходным кодом , включающего файл README; стандарты кодирования GNU рекомендуют включать файл, чтобы предоставить «общий обзор пакета». [10]
С момента появления Интернета как фактической стандартной платформы для распространения программного обеспечения многие программные пакеты переместили (или иногда скопировали) некоторые из вышеуказанных вспомогательных файлов и фрагментов информации на веб-сайт или вики , иногда включая сам файл README, а иногда оставляя только краткий файл README без всей информации, необходимой новому пользователю программного обеспечения.
Популярный сайт для размещения исходного кода GitHub настоятельно рекомендует создавать файл README — если он существует в главном (верхнем) каталоге репозитория, он автоматически отображается на главной странице репозитория. [11] Помимо простого текста, поддерживаются также различные другие форматы и расширения файлов , [12] а преобразование HTML учитывает расширения — в частности, README.mdрассматривается как GitHub Flavored Markdown .
Выражение «файл readme» иногда также используется в общем смысле для других файлов с аналогичным назначением. [ требуется ссылка ] Например, исходные коды многих пакетов свободного программного обеспечения (особенно тех, которые соответствуют стандартам Gnits или созданы с помощью GNU Autotools ) включают стандартный набор файлов readme:
Также вместе с пакетами программного обеспечения обычно распространяются файл часто задаваемых вопросов и TODOфайл, в котором перечислены планируемые улучшения.
Введение для хакера традиционно включается в каталог верхнего уровня исходного дистрибутива Unix и содержит указатель на более подробную документацию, информацию об авторах, разнообразную историю изменений, примечания и т. д. […] Когда хакеры спрашивают, они неизменно связывают соглашение README со знаменитой сценой из «Приключений Алисы в Стране чудес» Льюиса Кэрролла, в которой Алиса сталкивается с волшебными закусками с надписями «Съешь меня» и «Выпей меня».
[README.TXT — это DOC-файл для SPICE/SINC/SLIC] Эта отказоустойчивая лента содержит программы анализа цепей SPICE SINC и SLIC, описанные в Applications Software Bulletin Volume 4. Требования: SPICE требует FORTRAN-10 версии 4 из-за использования данных Holerith с поправкой на право. Выполняется примерно за 47 КБ. […] он также включает этот файл, FOROTS для работы с SAVes и исходный код для SECOND.MAC, процедуры синхронизации. SPICE разбит на три части: 1SPICE.FOR, 2 и 3. Существует печатный документ с описанием каждой из программ. Они включены в пакет DECUS. Документация и программы были первоначально разработаны кафедрой электротехники Калифорнийского университета в Беркли на CDC 6400. За исключением преобразования FORTRAN в DECsystem-10, в программы не было внесено никаких изменений. Для тестовых данных SLIC и SINC показали небольшое отклонение по сравнению с 6400, SPICE не показывает никаких отклонений. Удачи! Эшли Грейсон 27-НОЯ-74 [конец README.TXT]
Файлы на этой ленте FAILSAFE составляют систему UCI LISP. Они по большей части задокументированы в руководстве UCI LISP, доступном на кафедре информации и компьютерных наук Калифорнийского университета в Ирвайне, Калифорния.[1]
[…] у них были README (фактические физические печатные файлы) для всех их перфокарт и магнитной ленты и почти всего остального, что было "программой". В то время они действительно были нужны из-за трудоемкого процесса, который был связан с созданием, запуском и всем остальным. Эти README иногда также включали фактические распечатки того, как должны были быть пробиты перфокарты, как форму проверки ошибок и отладки. Соглашение, по-видимому, также следует старой системе в том, что со всеми перфокартами была прикреплена "пачка" бумаги с заявлением README, напечатанным заглавными буквами, на ней были все инструкции по использованию и загрузке перфокарт в систему. Для справки по времени это были 60-е годы. […]
Эта статья частично основана на Jargon File , который находится в открытом доступе.