READMEにはこれ書こう !

Last updated at 2024-07-07Posted at 2024-07-06

きっかけ

環境構築に関しての記載がREADMEにほぼない状態でPC移行作業を行い、
環境構築の大変さを改めて実感したこと

READMEとは

コードを閲覧するエンジニア、特に初めてのユーザーに方向性を示すことを目的

プロジェクトの目的を説明し、インストール手順を提供し、使用方法に関するガイダンスを提供し、プロジェクトに貢献する方法に関する情報を含むガイドとして機能します。

READMEに何書く?

オープンソースプロジェクトと内部プロジェクトでは対象ユーザーが異なるため、README ではその違いを反映する必要があります

1. コードの目的に関する情報
このパッケージ/ライブラリには何が含まれており、何に使用されるのか。

2. コードの使用方法およびビルド方法の説明
環境構築や実行方法など

3. 連絡先
恐らく、オープンソースの場合はEmailアドレスなど
内部プロジェクトの場合は担当課や担当チームなど

4. ステータス
このパッケージ/ライブラリが非推奨かどうか、一般リリース用かどうかなど

5. 詳細情報: 詳細なドキュメントを参照できる場所
より詳細な概念情報については、overview.md ファイルを参照してください

追記作成したREADME

追記部分 : 環境構築、環境変数

README.md

Project Name
これこれこうこう、こういうプロジェクトです。

ファイル構成
Project
 ├── main.py
 ├── lib
     ├── submain.py
     └── manage.py
 ├── log
     └── app.log
 ├── .env
 ├── .gitignore
 ├── config.ini
 ├── README.md
 └── requirements.txt


環境構築
サイトからダウンロードが必要な場合
Python
https://www.python.org/

システム環境変数設定が必要な場合
C:\User\user_name\AppData\...
C:\Program file\...

システム環境変数確認コマンド
python --version

実行方法
pip install -r requirements.txt

./venv/Scripts/activate
python main.py

※ batファイルでの実行の場合
batの置き場所、実行方法記載する

資料
Project Name Flowchart
Path/to/the/flowchart(フローチャートなどある場合保存先のパス)
APIなど使用した場合のドキュメント先
https://developers.google.com/gmail/postmaster?hl=ja