ПРОЧТИ МЕНЯ - README

Файл README для cURL

А ПРОЧТИ МЕНЯ файл содержит информацию о других файлах в каталог или же архив компьютера программного обеспечения. Форма документация, обычно это простой простой текст файл называется Прочти меня, ПРОЧТИ МЕНЯ,[1] README.TXT,[2][1] README.md[1] (для текстового файла с использованием уценка разметка), README.1ST[1] - или просто ПРОЧТИ МЕНЯ.[1]

Имя файла обычно пишется заглавными буквами. На Unix-подобный системы, в частности, это делает его легко заметным - как потому, что имена файлов в нижнем регистре более распространены, так и потому, что традиционно ls команда сортирует и отображает файлы в Порядок ASCII-кодов, так что имена файлов в верхнем регистре появляются первыми.[nb 1]

Содержание

Содержимое обычно включает одно или несколько из следующего:

История

Неясно, когда началась конвенция, но есть примеры, относящиеся к середине 1970-х годов.[4][5][6][7][8][9][1][нужен лучший источник ] Раннее системное программное обеспечение Macintosh устанавливало Read Me на загрузочный диск и обычно сопровождало стороннее программное обеспечение.

В частности, существует долгая история бесплатно программное обеспечение и программное обеспечение с открытым исходным кодом включая файл README; на самом деле это требование в Стандарты кодирования GNU.[10][нужен лучший источник ]

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

В последнее время популярный GitHub проприетарный Git хранилище[11] настоятельно рекомендует файл README - если он включен в основной (верхний уровень) каталог, он автоматически отображается на главной веб-странице. Хотя поддерживается традиционный простой текст, также поддерживаются различные расширения и форматы файлов,[12] при преобразовании в HTML учитывается расширение файла - в частности, файл "README.md" будет рассматриваться как Уценка со вкусом GitHub файл.

Как общий термин

Выражение «файл readme» также иногда используется в общем для файлов с аналогичной целью.[нужна цитата ] Например, исходный код распространение многих бесплатно программное обеспечение пакеты, особенно следующие за Стандарты Gnits или произведенные с GNU Autotools, включите стандартный набор файлов readme:

ПРОЧТИ МЕНЯОбщая информация
АВТОРЫКредиты
БЛАГОДАРНОСТЬБлагодарности
ИЗМЕНЕНИЕПодробный список изменений, предназначенный для программистов
НОВОСТИБазовый журнал изменений, предназначенный для пользователей
УСТАНОВИТЬИнструкции по установке
КОПИРОВАНИЕ / ЛИЦЕНЗИЯИнформация об авторских правах и лицензировании
ОШИБКИИзвестные ошибки и инструкции по сообщению о новых
СОДЕЙСТВИЕ / ВзломГид для потенциальных участников проекта

Другие файлы, обычно распространяемые с программным обеспечением, включают Часто задаваемые вопросы и СДЕЛАТЬ файл со списком возможных будущих изменений.

Смотрите также

Примечания

  1. ^ Часто это уже не так, но LC_ALL = C ls покажет старое поведение.

Рекомендации

  1. ^ а б c d е ж Абдельхафит, Омар (13 августа 2015 г.). "README.md: История и компоненты". В архиве из оригинала на 2020-01-25. Получено 2020-01-25.
  2. ^ Раймонд, Эрик Стивен (1996). Словарь нового хакера. MIT Press. С. 378–79. ISBN  978-0-26268092-9. Введение глазами хакера, традиционно включенное в каталог верхнего уровня исходного дистрибутива Unix, содержит указатель на более подробную документацию, кредиты, различную историю изменений, примечания и т. Д. […] Когда их спрашивают, хакеры неизменно связывают соглашение README с знаменитая сцена из «Приключений Алисы в стране чудес» Льюиса Кэрролла, в которой Алиса противостоит волшебным закускам с надписью «Съешь меня» и «Выпей меня».
  3. ^ а б Манес, Стивен (Ноябрь 1996 г.). «README? Конечно - перед покупкой!». Компьютерный мир. 14 (11): 366.
  4. ^ "Архив PDP-10: decus / 20-0079 / readme.txt из decus_20tap3_198111". pdp-10.trailing-edge.com. 1974-11-27. Получено 2018-03-03. [README.TXT - это файл DOC для SPICE / SINC / SLIC] Эта отказоустойчивая лента содержит программы анализа схем SPICE SINC и SLIC, описанные в бюллетене по прикладному программному обеспечению, том 4. Требования: SPICE требует FORTRAN-10 версии 4 из-за использования Правильно скорректированные данные Holerith. Выполняется примерно за 47К. […] Он также включает этот файл, FOROTS для сохранения и источник для SECOND.MAC, процедуру синхронизации. SPICE разбит на три части: 1SPICE.FOR, 2 и 3. Существует печатный документ с описанием каждой из программ. Они включены в пакет DECUS. Документация и программы были первоначально разработаны отделом E.E. Univ. из Калифорнии в Беркли на CDC 6400. За исключением преобразования FORTRAN в DECsystem-10, в программы не было внесено никаких изменений. Что касается тестовых данных, то SLIC и SINC показали небольшое отклонение по сравнению с 6400, SPICE не показывает изменений. Удачи! Эшли Грейсон 27-НОЯ-74 [конец README.TXT]
  5. ^ "DECUS 10-LIB-4 Содержит от 10-210 до 10-241, кроме 10-223". pdp-10.trailing-edge.com. 1975-03-27. Получено 2018-03-03. Файлы на этой ленте FAILSAFE составляют систему UCI LISP. По большей части они задокументированы в Руководстве UCI LISP, доступном в Департаменте информации и компьютерных наук Калифорнийского университета, Ирвин, Калифорния. [1]
  6. ^ "Programmer's Workbench / sys / source / lex / README". Июль 1977 г.. Получено 2020-01-25.
  7. ^ "Unix 7-е издание / usr / doc / README". 1979. Получено 2020-01-25.
  8. ^ "Первая 32-битная BSD usr / doc / README". Март 1980 г.. Получено 2020-01-25.
  9. ^ Лангемайер, Джефф (29.07.2011). "Re: Происхождение README". Получено 2020-01-25 - через Stackexchange. […] У них были README (реальные печатные файлы) для всех их перфокарт, магнитной ленты и всего остального, что было «программой». В то время он вам действительно был нужен из-за тяжелого процесса, связанного с созданием, запуском и всем остальным. Эти README иногда также включали фактические распечатки того, как перфокарты должны были перфорироваться, в качестве формы проверки ошибок и отладки. Соглашение, по-видимому, также следует старой системе в том смысле, что ко всем перфокартам прилагалась «стопка» бумаги с надписью README в колпачках, напечатанной на ней, там были все инструкции по использованию и загрузке перфокарт в систему. . Для справки, это были 60-е годы. […]
  10. ^ «Стандарты кодирования GNU: выпуски». www.gnu.org. Получено 2018-03-03.
  11. ^ «Сайту код-шеринга Github исполняется пять лет, и он насчитывает 3,5 миллиона пользователей, 6 миллионов репозиториев». TheNextWeb.com. 2013-04-11. Получено 2013-04-11.
  12. ^ «Разметка». GitHub. GitHub. 2014-12-25. Получено 2015-02-08.

дальнейшее чтение

Эта статья частично основана на Файл жаргона, который находится в открытом доступе.