突然ですがgitにプロジェクトをあげる際にREADMEを書いていますか？
エンジニアを志す者であれば必ず耳にしたことがあるであろうREADME、今回はその書き方を簡潔に分かりやすくまとめていきます。
READMEとは？
READMEとは、プロジェクトやソフトウェアの情報や使用方法を説明するためのファイルです。通常、プロジェクトのルートディレクトリに置かれ、他の開発者やユーザーがプロジェクトの目的、設定、使用方法を理解するのに役立ちます。
上のリンクのファイルのすぐ下に見れる長い文章がREADMEです。
そんなのいらなくね？
READMEを書く理由は様々あります。(プロジェクトの説明、インストール方法、使用方法など)
ですが、あえて初心者がREADMEを書くべきである理由は 「カッコいいから」 につきます。
最近プログラミングについて学び始めたあなたが、友人に目に見える成果で自慢をする最も簡単で効果のある方法はREADMEのあるgitを見せつけることです。
READMEがないプロジェクトはなんだか質素に見えます。あなたもこの記事でREADMEを書けるようになって友人に自慢しましょう。(半分冗談で半分本気です。)
実際に書いてみる
ここからは実際に書く方法を順を追って説明するので、あなたの実際のプロジェクトがあればそれを使いながら練習してみましょう。
- プロジェクトのルートディレクトリに"README.md"という名前のファイルを作成する。
- "#vim"のようにプロジェクトのタイトルを"#"で記載。
- "##使用方法"のようにプロジェクトの様々な説明を"##"で記載。
- 3の手順の記述の下にそれに関するより詳しい説明を記載。
- 3と4を繰り返す。
これだけです。といっても実際に何を書けばいいのか分からないと思うので、READMEの一般的なテンプレート文を用意しておきました。是非ご利用ください。
テンプレート文
以下がテンプレート文になります。今後もREADMEは全てのプロジェクトに作成することになるので、特に毎回書くのは面倒だと感じる人はこの記事をいいねするなどして今後も活用してください。
README.md
# プロジェクトタイトル
簡単なプロジェクトの説明をここに書きます。
## 概要
- このプロジェクトは何をするものか？
- なぜこのプロジェクトが必要なのか？
- 主な機能は何か？
## インストール方法
以下の手順でプロジェクトをローカル環境にインストールしてください。
```bash
リポジトリをクローン
git clone https://github.com/username/repository.git
ディレクトリに移動
cd repository
依存関係をインストール
pip install -r requirements.txt```
## 使い方
実行方法の例
```python main.py --option value```
## サンプル
サンプルコード
```print("Hello, World!")```
## ライセンス
このプロジェクトはMITライセンスのもとで公開されています。
## 貢献
貢献方法は以下の通りです。
1.フォークする。
2.新しいブランチを作成する。(git checkout -b feature/YourFeature)
3.コードをコミットする。(git commit -m 'Add some feature')
4.プッシュする。(git push origin feature/YourFeature)
5.プルリクエストを作成する。
## クレジット
(使用したライブラリや貢献者の名前を記す。)
DuC
(余談)
qiitaを普段から利用している方ならもうお気づきかと思いますが、READMEはMarkdown記法によって書かれます。
終わりに
いかがでしたか。この記事でREADMEの書き方を知ったという人は今後も必ず全てのプロジェクトにREADMEを書いていくことを強くお勧めします。
最後に、もしこの記事が役に立てたのならいいねやフォローをお願いします。