READMEとは

README(リードミー)とは、ソフトウェアなどに添付される説明書のようなファイルです。
転職などでポートフォリオを作成することも多いと思いますが、まず見られるのはGitHubのREADMEです。
そのアプリがどう言うものなのか、どのように使うのかなどを記載しておくことで、アピールにもなります。
この記事では、「GitHubを使いはじめたけどREADMEってなんぞや？」という方のために、
シンプルな書き方をご紹介していきます。

Markdown記法

GitHubのREADMEはMarkdownで書くことができます。
Markdownとは文章を書くための言語の一つで、簡単に言ってしまえば文章をHTML変換してくれるものです。
例えば見出しを作るときは

見出しh1

# 見出しh1

見出しh2

# 見出しh2

見出しh3

# 見出しh3

というように書きます。#の後に半角スペースを挟み、タイトルを入力します。
詳しくは、Markdown記法 チートシートをご覧ください。

シンプルな書き方

READMEに書く項目は以下のような感じです。

• コンセプト
• 目的
• 使い方
• 機能
• 技術

一つずつ見ていきましょう。

コンセプト

アプリのコンセプトを一言で書きましょう。詳しい説明は省いて、どういうアプリかを端的に表すキャッチコピーのようにしましょう

シンプルで直感的なデザインのタスク管理アプリです。

目的

ここからアプリの詳しい説明を書いていきます。
とは言っても常にシンプルでわかりやすく書くことを意識してください。
まずはアプリの目的です。何のために作ったのか、何を実現できるのかを説明します。

急いでいる時でもすぐにタスクを追加できるように、使いやすさを重視して開発しました。

使い方

どのようにアプリを使うのかを紹介していきます。
全て網羅する必要はなく、あくまでも主要な機能で十分です。
画像やgifを挿入したらよりイメージしやすくなります。

機能

アプリがどのような機能を持つのかを書いていきます。
言い換えると、自分がどういう機能を実装できるかということなので、
書き漏らさないようにしっかり記述しましょう。

• ユーザー登録
• ログイン
• タスクのCRUD
• カテゴリー

技術

使用した技術を書いていきます。機能の項目と同様に、箇条書きで記入していきます。
言語やフレームワークのバージョンも忘れず書きます。

• HTML/CSS
• Ruby 2.6.6
• Ruby on Rails 5.2.6
• MySQL 8.0
• AWS
• Docker

まとめ

以上がGitHubのREADMEのシンプルな書き方でした。
READMEをしっかり書いているかどうかで、アプリの印象も変わってくるので
サボらず記入しましょう。