README ファイル形式とは?
.readme ファイルは、Unix やオープンソースソフトウェア文化の README 慣習に従ったプレーンテキストのドキュメントファイルです。.readme 拡張子は、伝統的な大文字の README(拡張子なし)や README.txt 形式の珍しい派生形です。
README ファイルは、ソフトウェアパッケージ、プロジェクト、またはアーカイブに関する人間が読める導入ドキュメントを提供します。一般的な内容には、プロジェクトの説明、インストールと使用の手順、作成者情報、およびライセンス通知が含まれます。強制的な構造はなく、内容は自由形式の文章やリストで構成されます。
拡張子のない大文字の README は、少なくとも1970年代の Unix ディストリビューションにまで遡ります。そこでは、ユーザーが最初に読むべきファイルとして慣習的に扱われており、パッケージマネージャーやディレクトリ一覧で自動的に表示されることがよくありました。Windows では README.txt が一般的になりました。2008年頃からは、GitHub がリポジトリページで自動的にレンダリングするため、README.md (Markdown) が主流の形式となっています。
.readme 拡張子は、古いシェアウェアの配布物や特定のパッケージマネージャーで時折見られますが、.txt との技術的な違いはありません。どちらも設定なしで任意のエディタで開けるプレーンテキストです。エンコーディングは通常 UTF-8(現代的)または ASCII(レガシー)です。Windows のツールでは BOM 付きの UTF-16 LE ファイルが作成されることもありますが、UTF-8 が標準です。ファイルサイズはほとんどの場合 100 KB 未満です。
セキュリティと安全性
リスク: LOWプレーンテキストファイル。実行コードは含まれず、どのテキストエディタで開いても完全に安全です。
形式の詳細
概要README ファイルを開くプログラム
技術的詳細
詳細仕様| エンコーディング | UTF-8(現代の標準)、ASCII(レガシー)、Windows では稀に BOM 付き UTF-16 LE |
| コンテナ | プレーンテキスト - バイナリラッパー、ヘッダー、スキーマなし |
| 必須構造 | なし - 自由形式の文章。定義されたフィールドや必須の順序はありません |
| 一般的なファイル名のバリエーション | README(拡張子なし)、README.txt、README.md、.readme |
| MIME タイプ | text/plain |
| 典型的なファイルサイズ | ほとんどの場合 100 KB 未満 |
| 改行コード | LF (Unix/macOS/Linux) または CRLF (Windows)。どちらもテキストエディタで受け入れられます |
| UTF-8 BOM | 任意 - Windows で作成されたファイルに存在する可能性があります (EF BB BF プレフィックス) |
| 現代の主流形式 | README.md (Markdown)。2008年頃から GitHub、GitLab、Bitbucket によって自動レンダリングされます |
| 歴史的な表示 | 初期の 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 の変換
コミュニティ Q&A
ユーザーからの質問まだ質問はありません。README ファイルについて最初の質問をしてみましょう。