MD ReaderAndroid で README.md を読む方法
README.md は、ソフトウェアプロジェクトの概要、インストール方法、使い方を説明するファイルです。Markdown で書かれているため、スマホではそのままではただのテキストとして表示されるか、開けないことがあります。
GitHub の README ファイル
プロジェクトが GitHub にある場合、GitHub のウェブサイトですでにフォーマットされた状態で表示されます。ブラウザでリポジトリのページを開くだけで十分です。ビュアーが必要になるのは、以下のようにファイル単体を手に入れた場合です。
- プロジェクトを ZIP ファイルとしてダウンロードした
- 誰かに README を送ってもらった
- ファイルがただのテキストとして表示されるサーバーやドライブにある
- 電車や飛行機など、オフラインで読みたい
Android で README.md を開く
- Markdown ビュアーをインストールします。ここでは MD Reader を使用します。
- Files を開き、
README.mdをタップして MD Reader を選択します。 - または MD Reader を開き、ファイルを開くをタップして README を選択します。
ZIP ファイルからの場合: Android の Files アプリ（Files by Google）で ZIP ファイルを解凍できます。ZIP をタップしてすべて展開を選び、展開されたフォルダから README.md を開きます。
生データ（Raw）のリンクからの場合: ブラウザで生データの README リンクを開くと、プレーンテキストが表示されます。長押ししてすべて選択、コピーを行い、MD Reader のクリップボードから貼り付けを使用します。
表示される内容
README は他の文書よりも多くの書式を使用します。MD Reader では以下のように表示されます。
- インストールコマンドに便利な、シンタックスハイライト付きのコードブロック（ワンタップでコピー可能）。スマホでのコードブロックの表示をご覧ください。
- オプションやフラグをまとめたテーブル（幅が広い場合は横スクロール可能）。
- ロードマップ項目を示すチェックリスト。
- アーキテクチャを示す Mermaid 図。Android での Mermaid 図をご覧ください。
> [!WARNING]などのコールアウト。- 見出しから自動生成される目次。「Installation」などのセクションへすぐにジャンプできます。
リンクと画像について
ウェブサイトへのリンクはブラウザで開きます。プロジェクト内の他のファイル（docs/setup.md など）へのリンクを開くにはフォルダ全体が必要となるため、現時点ではそれらのファイルを個別に開いてください。ウェブを指す画像は読み込みにインターネットが必要です。MD Reader はインターネットアクセスを要求しないため、リモート画像は読み込まれませんが、その周囲のテキストは問題なく読むことができます。