From 1b8584549942c5db9390dca81f527c0fb17006c0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=82=8D=E3=82=80=E3=81=AD=E3=81=93?= <nem@nem.x0.to>
Date: Thu, 11 Jan 2024 10:59:36 +0900
Subject: [PATCH] =?UTF-8?q?Readme.md=E3=81=AB=E8=AA=AC=E6=98=8E=E3=82=92?=
 =?UTF-8?q?=E8=BF=BD=E5=8A=A0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index 8f9e28fc..436e13a0 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,44 @@ WIP
 ## メモ
 - アイコン: Google Material Icons https://fonts.google.com/icons (Weight:300, Grade:0, Optical size: 24px)
 
+## モジュール構成
+### モジュール一覧
+- `component` : コンポーネント
+  - `common` : 共通コンポーネント
+    - UIの中で共通で使う要素(メニューアイテムとか)
+  - `scanner` : スキャナー
+    - スキャナーの実装
+  - `viewer` : ビューワー
+    - ドキュメントビューワーの実装
+- `data` : データ
+  - UIからデータを取得/保存するためのラッパーモジュール
+  - `Document` : ドキュメント関係
+    - WIP(JavaDocを参照してください, 余裕があったら追記します)
+- `feature` : 機能モジュール(ナビゲーションからみた機能で分割)
+  - `common`: 共通機能
+    - 設定画面とか、どこからでも呼ばれうる画面
+  - `debug`: デバッグメニュー
+  - `home`: ホーム画面
+  - `library`: ライブラリ画面
+  - `scan`: スキャン画面
+  - `search`: 検索画面
+- `model` : モデル
+  - データモデルをまとめたモジュール (WIP)
+  - `document` : ドキュメント
+  - `meta` : メタデータ
+- `processor` : プロセッサ
+  - いくつかの処理をまとめたモジュール
+    - `DocumentProcessor` : ドキュメント処理（ドキュメントにページを追加したり更新したり） 
+- `shared` : 
+  - 共有リソース
+- `source` : ソース
+  - (バックエンドが使うのでとりあえず後回し、フロントから直接操作することは絶対にありません)
+- `utils` : ユーティリティ
+  - ちょっとしたユーティリティをまとめたモジュール
+  - `LacertaLogger` : ロガー
+  - `XmlMetaParser` : XMLメタデータパーサー(フロントから直接操作することは絶対にありません)
+
+
 ## コーディング規則/推奨(WIP)
 ### 規則
 - `// TODO`コメントには任意のsuffixを付ける