README-файл: различия между версиями

65 байт добавлено ,  2 года назад
ну так
[непроверенная версия][непроверенная версия]
(К удалению)
Метки: правка с мобильного устройства правка из мобильной версии
(ну так)
<noinclude>{{к удалению|2020-09-10}}</noinclude>
'''README-файл''' (от {{lang-en|read me}} — «прочти меня») — [[текстовый файл]], содержащий информацию о других [[файл]]ах в том же [[Каталог (файловая система)|каталоге]] или [[Архив (информатика)|архиве]]; такой файл обычно сопровождает [[дистрибутив]] программы при распространении.
 
'''README''' (от {{lang-en|read me}} — прочти меня) — [[текстовый файл]], который распространяется вместе с [[Программное обеспечение|программным обеспечением]] и содержит информацию о нём. README-файл может включать подробную документацию или сведения, которые появились уже после выпуска печатной инструкции, имена авторов программы, историю версий, комментарии, примечания по использованию ПО с конкретным [[Аппаратное обеспечение|аппаратным обеспечением]] и т.д. Такой файл может быть открыт в любом текстовом редакторе или процессоре, поскольку в нём не используются форматирование или нестандартные символы<ref name=dictionary>{{книга |заглавие=Dictionary of Networking |автор=Peter Dyson |год=1999 | страниц=448 |isbn=978-0782124613 |издательство=Sybex}}</ref>.
Такой файл обычно имеет имя <code>readme.txt</code>, <code>README</code>, <code>readme.1st</code> (от {{lang-en2|read me first}} — сначала прочти меня), <code>read.me</code>.
Иногда в архиве имеется несколько таких файлов на разных языках. Язык может указываться в расширении (<code>readme.en</code>, <code>readme.ru</code>, <code>readme.by</code>) или переводом имени файла (<code>LEEME</code>, <code>LISEZMOI.TXT</code>, <code>CZYTAJTO.txt</code>).
 
Файл может иметь имена <code>readme.txt</code>, <code>readme.doc</code>, <code>readme.1st</code> (от {{lang-en|read me first}} — сперва прочти меня), <code>read.me</code>, <code>readme.md</code> и пр.<ref name=dictionary /> Словарь слэнга The New Hacker's Dictionary отмечал, что происхождение названия README-файла может быть связано с «Алисой в Стране чудес» [[Льюис Кэрролл|Льюиса Кэрролла]]. В одной из сцен книги с героиней происходят метаморфозы, когда она употребляет волшебные продукты с надписями «Выпей меня!» ({{lang-en|Drink me!}}) и «Съешь меня!» ({{lang-en|Eat me!}})<ref>{{Cite book |title=The New Hacker's Dictionary |author=Eric Steven Raymond |date=1996 |publisher=[[MIT Press]] |isbn=978-0-26268092-9 |pages=378–79 |url=https://books.google.com/books?id=g80P_4v4QbIC}}</ref><ref>{{cite web |title=README.md: History and Components |author=Omar Abdelhafith |date=2015-08-13 |url=https://medium.com/@NSomar/readme-md-history-and-components-a365aff07f10 |access-date=2020-01-25 |archive-url=https://archive.today/20200125153450/https://medium.com/@NSomar/readme-md-history-and-components-a365aff07f10 |archive-date=2020-01-25}}</ref>.
В некоторых случаях (часто вместе с текстовой версией) файл может быть представлен в [[HTML]] (<code>readme.html</code>) или другом формате (например, [[RTF]] [<code>readme.rtf</code>] или [[Microsoft Word]] [<code>readme.doc</code>] в Microsoft Windows). С ПО для [[DOS]] расширение <code>[[DOC|DOC]]</code> использовалось и для текстовых файлов.
 
== Содержание ==
 
Файл README обычно включает в себя:
* информацию о системных требованиях
* инструкции по установке программы
* инструкции по настройке
* инструкции по управлению программой
* информацию о [[Лицензия на программное обеспечение|лицензии]] и [[авторское право|авторском праве]]
* контактную информацию — как связаться с автором и/или распространителем
* известные ошибки (иногда выносится в файл <code>BUGS</code>)
* инструкции по устранению неполадок
* сведения об авторах и благодарности
* протокол изменений программы (обычно выносится в файлы типа [[ChangeLog]] и NEWS)
 
== См. также ==
 
* [[NFO]]
* [[FILE_ID.DIZ]]
* [[Журнализация изменений проекта]]
 
== Примечания ==
{{compu-soft-stub}}
 
{{Computer-data-stub}}
{{примечания}}
{{нет ссылок|дата=7 июня 2019}}
 
[[Категория:Техническая документация]]