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

Материал из Википедии — свободной энциклопедии
Перейти к навигации Перейти к поиску
[непроверенная версия][непроверенная версия]
Содержимое удалено Содержимое добавлено
Нет описания правки
Нет описания правки
Строка 1: Строка 1:
'''README-файл''' (от {{lang-en|read me}} — «прочти меня») — [[текстовый файл]], содержащий информацию о других [[файл]]ах в том же каталоге или архиве; такой файл обычно сопровождает [[дистрибутив]] программы при распространении. Такой файл обычно имеет имя <code>readme.txt</code>, <code>readme.1st</code>, <code>read.me</code> или просто <code>readme</code>. В некоторых случаях файл может быть представлен в формате [[RTF]], [[Microsoft Word]] (<code>readme.doc</code>), [[HTML]] (<code>readme.htm</code>) и т.п.
'''README-файл''' (от {{lang-en|read me}} — «прочти меня») — [[текстовый файл]], содержащий информацию о других [[файл]]ах в том же каталоге или архиве; такой файл обычно сопровождает [[дистрибутив]] программы при распространении. Такой файл обычно имеет имя <code>readme.txt</code>, <code>readme.1st</code>, <code>read.me</code> или просто <code>readme</code>. В некоторых случаях файл может быть представлен в формате [[RTF]] (<code>readme.rtf</code>), [[Microsoft Word]] (<code>readme.doc</code>), [[HTML]] (<code>readme.htm</code>) и т.п.


Файл README обычно включает в себя:
Файл README обычно включает в себя:

Версия от 18:13, 20 марта 2008

README-файл (от англ. read me — «прочти меня») — текстовый файл, содержащий информацию о других файлах в том же каталоге или архиве; такой файл обычно сопровождает дистрибутив программы при распространении. Такой файл обычно имеет имя readme.txt, readme.1st, read.me или просто readme. В некоторых случаях файл может быть представлен в формате RTF (readme.rtf), Microsoft Word (readme.doc), HTML (readme.htm) и т.п.

Файл README обычно включает в себя:

  • инструкции по установке программы
  • инструкции по настройке
  • инструкции по управлению программой
  • информацию о лицензии и авторском праве
  • контактную информацию — как связаться с автором и/или распространителем
  • известные ошибки
  • инструкции по устранению неполадок
  • сведения об авторах и благодарности
  • протокол изменений программы