README.md に書くべき内容

Rails の初期ソースコードには、README.mdというファイルが含まれている。

ここには、これから作成するアプリの基本的な情報を記述する。

例えば・・・

　⚫︎アプリケーションの簡単な説明

　⚫︎推奨されるシステム環境

　⚫︎インストールの手順

　⚫︎データベースの初期化の手順

　⚫︎テストの実行手順など

※初期状態で書かれているのは単なる記述例に過ぎないので、

全て削除してしまって大丈夫。

◉記述方式

Markdown 方式で記入する。

⚫︎見出し

行頭に「#」を挿入すると、見出しに変換される。
見出しレベルに応じて、#(ハッシュ記号)の数を増やす。

⚫︎テキスト装飾(太字、イタリック)

「*」もしくは「_」で文字を囲めばイタリック体が適用される。

2つ囲めば、太字になる。

⚫︎リスト

文頭に「*」、「+」、「-」のいずれかを入れるとDisc型リスト(ulリスト)になる。
文頭に「1.」、「2.」、「3.」...を入れるとDecimal型リスト(olリスト)になる。
リストの上下に空行を入れる必要がある。

⚫︎引用

行頭に>を置く事で引用になる。

複数業にまたがる場合、改行の度に>を置く必要がある。

引用の中に別のMarkdownを使用する事も可能。
引用の上下に空行を入れる必要がある。

など。