README-файл

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

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

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