READMEファイルの役割
- READMEファイルは主に「システムの概要」「ツールの使い方」「インストール方法」などが記述される。
- リポジトリに格納されたソースコードを利用したり、参照する前に読んでほしい内容が記載される。
READMEファイルの記述法
READMEファイルは「マークダウン記法」で記述されるファイルで、マークダウン記法では文字の装飾を簡単に行うことが出来るため、読みやすいドキュメントを効率的に作成することが出来る。
READMEの作成方法
- リポジトリの画面を開き、「Add a README」をクリックする。
- ファイル編集画面が開く。
- 内容を編集し、「Commit a new file」をクリックする。
- READMEファイルが作成される。
※ リポジトリを新規作成する場合は、「Initialize this repository with a README」にチェックを入れるとリポジトリ作成と同時に自動で作成される。
READMEの編集方法
- リポジトリのページ「README.md」ファイルをクリックする。
- 右上の「鉛筆」マークを押す。
- READMEファイルの編集画面が開く。
※ リポジトリのページでREADMEセクションの編集アイコンをクリックする方法も可能
- 内容を編集し、「Commit changes」（もしくは「Commit a new file」）をクリックする。
- READMEが編集した内容で更新される。
READMEに画像を入れる方法
- リポジトリのページを開いて「Upload files」をクリックする。
- 「choose your files」をクリックするか、画像ファイルをドラッグ&ドロップでアップロードする。
- ファイルの名称が表示されていることを確認し「Commit changes」をクリックする。
- 画像がアップロード済み。
- 続いてREADMEファイルを編集してマークダウンで画像のパスを指定する。
※ 画像のパスは「相対パス指定」「絶対パス指定」のどちらでも可能。
相対パス指定の場合
README.mdファイルから見た画像のパスを指定する。
README.mdファイルを編集して以下の記述を追加する。
 //画像名は任意の名称を記述する。
仮に「images」フォルダを作成して格納する場合はパスは「./images/sample_image.jpg」となる。
絶対パス指定の場合
絶対パスの指定は、画像のURLをそのまま画像のパスに使用する方法。
① リポジトリから画像ファイルをクリックして絶対パスのURLを取得する。
② README.mdには以下のように記述する。
- READMEに画像のマークダウンが記述できら「Commit changes」で更新する。
- READMEに画像が追加。
参考サイト
【GitHub】READMEって使ってる？使い方と書き方を確認しよう
GitHub – READMEの作成方法と書き方【改行やリンク・画像の入れ方】