Оглавление
ЧИТАЙ МЕНЯ
-
Определение и содержание файла README
- Файл README содержит информацию о программном обеспечении и его файлах.
- Обычно это текстовый файл с названием README, ПРОЧИТАЙ.ME или README.txt.
- В Unix-подобных системах имена файлов в верхнем регистре выделяются.
-
Содержание файла README
- Включает инструкции по настройке, установке, эксплуатации и другие.
- Содержит информацию об авторских правах, лицензировании, контактах и известных ошибках.
- Может содержать инструкции по устранению неполадок, благодарности и список изменений.
- Может включать раздел новостей и историю разработки.
-
История и распространение файла README
- Неизвестно точное время появления файла README, но примеры относятся к середине 1970-х.
- В Macintosh и в свободном программном обеспечении README был стандартным элементом.
- С развитием Интернета README часто размещается на веб-сайтах и в вики.
- GitHub рекомендует создавать README для отображения на главной странице репозитория.
-
Использование термина “файл readme”
- “Файл readme” может использоваться в общем смысле для обозначения файлов с аналогичными функциями.
- Дистрибутивы с исходным кодом часто включают стандартный набор файлов readme.
- Вместе с программными пакетами могут распространяться файлы часто задаваемых вопросов и задач.