From 72cf523232b4e1e2e6f3d996b1d065547ecd6aac Mon Sep 17 00:00:00 2001 From: Yuto Yamazaki Date: Wed, 11 Mar 2026 13:18:20 +0900 Subject: [PATCH] =?UTF-8?q?README.md=E3=82=92=E6=96=B0=E8=A6=8F=E4=BD=9C?= =?UTF-8?q?=E6=88=90=E3=81=97=E3=80=81=E8=87=AA=E5=AE=85=E3=83=8D=E3=83=83?= =?UTF-8?q?=E3=83=88=E3=83=AF=E3=83=BC=E3=82=AF=E3=81=AE=E8=A8=AD=E8=A8=88?= =?UTF-8?q?=E3=83=BB=E9=81=8B=E7=94=A8=E3=83=A1=E3=83=A2=E3=81=A8=E3=83=89?= =?UTF-8?q?=E3=82=AD=E3=83=A5=E3=83=A1=E3=83=B3=E3=83=88=E3=82=92=E6=95=B4?= =?UTF-8?q?=E7=90=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..96accaf --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# HomeNetwork — 自宅ネットワーク資産リポジトリ + +このリポジトリは、自宅ネットワークの設計・運用メモ、ドキュメント、構成ファイルを一元管理するためのものです。 + +目的: +- ネットワーク構成図、IP割当、運用メモを参照・更新できるようにする +- Docker やサーバ構成のポート情報をまとめる +- 設備増備計画やラック構成などの設計ドラフトを整理する + +主要ディレクトリ: +- `docs/` — 最終化したドキュメント（Network図、増備計画、ポート一覧など） +- `feature/` — 検討中の設計やドラフト（各サブディレクトリに README を置き、目的を明記しています） +- `now/` — 現在の運用メモと即時参照用ドキュメント +- `.prompt/` — このリポジトリの編集方針や AI 補助プロンプト + +運用上の注意: +- 空ディレクトリのプレースホルダとして `.gitkeep` は削除済みです。空ディレクトリを残す場合は、目的を記載した `README.md` を配置してください。 +- ドキュメントを更新したら `docs/` に移すか、`feature/` と `now/` の使い分けルールに従ってください。 +- Docker 関連のポート情報は `docs/DOCKER_PORTS.md` にまとめてあります。compose ファイルに変更があれば更新をお願いします。 + +編集の流れ（推奨）: +1. 小さな変更（文言修正・軽微な追記）は `now/` 配下の該当ファイルを編集 +2. 設計変更や新規ドキュメントは `feature/` に草案を置き、確定後 `docs/` へ移動 +3. 重要な運用変更はコミットメッセージに目的を明確に記載 + +問い合わせ・連絡: +- リポジトリ管理者に issue を立ててください。 + +--- +更新履歴: +- 2026-03-11: ディレクトリ整理、`docs/` 集約、`docs/DOCKER_PORTS.md` 追加