README-файл: различия между версиями
[непроверенная версия] | [отпатрулированная версия] |
AVRS (обсуждение | вклад) отмена правки 20062370 участника 92.242.85.232 (обс): там написано, почему. |
м робот добавил: uk:README-файл |
||
Строка 37: | Строка 37: | ||
[[pl:README]] |
[[pl:README]] |
||
[[pt:Readme]] |
[[pt:Readme]] |
||
[[uk:README-файл]] |
Версия от 11:45, 25 марта 2010
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)
См. также
Это заготовка статьи о программном обеспечении. Помогите Википедии, дополнив её. |