README-файл: различия между версиями
| [отпатрулированная версия] | [отпатрулированная версия] |
EmausBot (обсуждение | вклад) м r2.6.4) (робот добавил: sh:Readme; косметические изменения |
Nzeemin (обсуждение | вклад) Нет описания правки |
||
| Строка 1: | Строка 1: | ||
'''README-файл''' (от {{lang-en|read me}} — «прочти меня») — [[текстовый файл]], содержащий информацию о других [[файл]]ах в том же каталоге или архиве; такой файл обычно сопровождает [[дистрибутив]] программы при распространении. |
'''README-файл''' (от {{lang-en|read me}} — «прочти меня») — [[текстовый файл]], содержащий информацию о других [[файл]]ах в том же [[Каталог (файловая система)|каталоге]] или [[Архив (информатика)|архиве]]; такой файл обычно сопровождает [[дистрибутив]] программы при распространении. |
||
Такой файл обычно имеет имя <code>readme.txt</code>, <code>README</code>, <code>readme.1st</code> (от {{lang-en2|read me first}} — сначала прочти меня), <code>read.me</code>. |
Такой файл обычно имеет имя <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.en</code>, <code>readme.ru</code>, <code>readme.by</code>) или переводом имени файла (<code>LEEME</code>, <code>LISEZMOI.TXT</code>, <code>CZYTAJTO.txt</code>). |
||
В некоторых случаях (часто вместе с текстовой версией) файл может быть представлен в [[HTML]] (<code>readme.html</code>) или другом формате (например, [[RTF]] [<code>readme.rtf</code>] или [[Microsoft Word]] [<code>readme.doc</code>] в Microsoft Windows). С ПО для [[DOS]] расширение <code>[[DOC (расширение имени файла)|DOC]]</code> использовалось и для текстовых файлов. |
В некоторых случаях (часто вместе с текстовой версией) файл может быть представлен в [[HTML]] (<code>readme.html</code>) или другом формате (например, [[RTF]] [<code>readme.rtf</code>] или [[Microsoft Word]] [<code>readme.doc</code>] в Microsoft Windows). С ПО для [[DOS]] расширение <code>[[DOC (расширение имени файла)|DOC]]</code> использовалось и для текстовых файлов. |
||
== Содержание == |
|||
Файл README обычно включает в себя: |
Файл README обычно включает в себя: |
||
Версия от 17:34, 2 ноября 2011
README-файл (от англ. read me — «прочти меня») — текстовый файл, содержащий информацию о других файлах в том же каталоге или архиве; такой файл обычно сопровождает дистрибутив программы при распространении.
Такой файл обычно имеет имя readme.txt, README, readme.1st (от read me first — сначала прочти меня), read.me.
Иногда в архиве имеется несколько таких файлов на разных языках. Язык может указываться в расширении (readme.en, readme.ru, readme.by) или переводом имени файла (LEEME, LISEZMOI.TXT, CZYTAJTO.txt).
В некоторых случаях (часто вместе с текстовой версией) файл может быть представлен в HTML (readme.html) или другом формате (например, RTF [readme.rtf] или Microsoft Word [readme.doc] в Microsoft Windows). С ПО для DOS расширение DOC использовалось и для текстовых файлов.
Содержание
Файл README обычно включает в себя:
- информацию о системных требованиях
- инструкции по установке программы
- инструкции по настройке
- инструкции по управлению программой
- информацию о лицензии и авторском праве
- контактную информацию — как связаться с автором и/или распространителем
- известные ошибки (иногда выносится в файл
BUGS) - инструкции по устранению неполадок
- сведения об авторах и благодарности
- протокол изменений программы (обычно выносится в файлы типа ChangeLog и NEWS)
См. также
 | Это заготовка статьи о программном обеспечении. Помогите Википедии, дополнив её. |