Gitリポジトリの顔であるREADME.mdには主に４つのことを書くべきだと思います。

1. このリポジトリの説明。
2. ビルド（環境構築）の方法。
3. テストの実行方法。
4. デプロイの仕組みや方法。

基本、README.mdは最低限に留めておくべきというのが自論です。

細かいTipsなどはNotionなど何か別のサービスで管理し、`./README.md`には実行手順のみ書くべきかなと思います。

だって、手順書やTipsをGit管理していたらマージリクエストがものすごい数になっちゃいますからね。。。

まとめ

README.mdは実行手順のみのシンプルな記述にとどめておくべき！