Что такое формат файла README?
Файл .readme - это текстовый файл документации, следующий конвенции README из культуры Unix и программного обеспечения с открытым исходным кодом. Расширение .readme является редким вариантом традиционных форм README в верхнем регистре (без расширения) и README.txt.
Файлы README содержат вводную документацию для программного пакета, проекта или архива, предназначенную для чтения человеком. Типичное содержимое включает описание проекта, инструкции по установке и использованию, информацию об авторе и уведомление о лицензии. Обязательной структуры не существует - содержимое представляет собой текст в свободной форме и списки.
Файл README в верхнем регистре без расширения появился как минимум в 1970-х годах в дистрибутивах Unix, где он традиционно был первым файлом, который должен был прочитать пользователь; менеджеры пакетов и списки каталогов часто отображали его автоматически. README.txt стал обычным явлением в Windows. Примерно с 2008 года доминирующей формой стал README.md (Markdown), поскольку GitHub автоматически отрисовывает Markdown на страницах репозиториев.
Расширение .readme изредка встречается в старых дистрибутивах shareware и некоторых менеджерах пакетов, но технически оно ничем не отличается от .txt - оба являются обычным текстом, который любой редактор открывает без дополнительной настройки. Кодировка обычно UTF-8 (современная) или ASCII (устаревшая); инструменты Windows могут создавать файлы UTF-16 LE с BOM, но стандартом является UTF-8. Размер файла почти всегда составляет менее 100 КБ.
Безопасность и защита
РИСК: LOWОбычный текстовый файл; не содержит исполняемого кода; полностью безопасен для открытия в любом текстовом редакторе.
Детали формата
в двух словахПрограммы, открывающие файлы README
Windows3 apps
Windows Notepad
Встроенная Двойной клик может не сработать (ОС может не распознать расширение .readme); щелкните правой кнопкой мыши → «Открыть с помощью» → «Блокнот». 
Notepad
Открытый код Правой кнопкой мыши → «Открыть с помощью» → Notepad++; или перетащите в окно Notepad++. 
Visual Studio Code
Открытый код Файл → Открыть файл, выберите файл .readme; отображается как обычный текст. 
macOS2 apps
Visual Studio Code
Открытый код Файл → Открыть файл, выберите файл .readme; отображается как обычный текст. 
Linux2 apps
Технические подробности
глубокая спецификация| Кодировка | UTF-8 (современный стандарт); ASCII (устаревшая); иногда UTF-16 LE с BOM в Windows |
| Контейнер | Обычный текст - без бинарной оболочки, без заголовка, без схемы |
| Обязательная структура | Отсутствует - свободная форма; нет определенных полей или обязательного порядка |
| Общие варианты имен файлов | README (без расширения), README.txt, README.md, .readme |
| MIME-тип | text/plain |
| Типичный размер файла | Почти всегда менее 100 КБ |
| Окончания строк | LF (Unix/macOS/Linux) или CRLF (Windows); оба принимаются текстовыми редакторами |
| UTF-8 BOM | Необязательно - возможно в файлах, созданных в Windows (префикс EF BB BF) |
| Доминирующая современная форма | README.md (Markdown), автоматически отрисовываемый GitHub, GitLab и Bitbucket примерно с 2008 года |
| Историческое отображение | Автоматически отображался ранними списками каталогов Unix и менеджерами пакетов |
| Связанные платформы | Все операционные системы - Windows, macOS, Linux, Unix |
| Типичное содержимое | Описание проекта, инструкции по установке/использованию, информация об авторе, уведомление о лицензии |
| Выпущен | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Последняя версия | N/A - no versioning |
| Открыть стандартное | Да · без роялти |
Конвертации README
Вопросы и ответы сообщества
спрошено пользователямиВопросов пока нет - станьте первым, кто спросит о файлах README.
