mirror of
https://github.com/lacerta-doc/Lacerta.git
synced 2024-11-22 16:03:15 +00:00
Update README.md
This commit is contained in:
parent
9d229a2857
commit
6f94b3408f
46
README.md
46
README.md
|
@ -1,8 +1,9 @@
|
||||||
# Lacerta
|
# Lacerta
|
||||||
WIP
|
学習に便利な機能とGit-like VCSを持ったドキュメントスキャナ (Work In Progress)
|
||||||
## モジュール設計
|
|
||||||
|
## モジュール設計
|
||||||
|
![Untitled Diagram(2)(1) drawio(1)](https://github.com/lacerta-doc/Lacerta/assets/66072112/f9b9c40f-bed0-4ade-95c1-50e28df68f35)
|
||||||
|
|
||||||
![Untitled Diagram(2)](https://github.com/lacerta-doc/Lacerta/assets/66072112/9daabaca-5cdc-49f8-ac66-196c588a47c9)
|
|
||||||
|
|
||||||
## メモ
|
## メモ
|
||||||
- アイコン: Google Material Icons https://fonts.google.com/icons (Weight:300, Grade:0, Optical size: 24px)
|
- アイコン: Google Material Icons https://fonts.google.com/icons (Weight:300, Grade:0, Optical size: 24px)
|
||||||
|
@ -11,45 +12,28 @@ WIP
|
||||||
### モジュール一覧
|
### モジュール一覧
|
||||||
- `component` : コンポーネント
|
- `component` : コンポーネント
|
||||||
- `common` : 共通コンポーネント
|
- `common` : 共通コンポーネント
|
||||||
- UIの中で共通で使う要素(メニューアイテムとか)
|
|
||||||
- `scanner` : スキャナー
|
- `scanner` : スキャナー
|
||||||
- スキャナーの実装
|
|
||||||
- `viewer` : ビューワー
|
- `viewer` : ビューワー
|
||||||
- ドキュメントビューワーの実装
|
- `data` : UIからデータを取得/保存するためのラッパーモジュール
|
||||||
- `data` : データ
|
|
||||||
- UIからデータを取得/保存するためのラッパーモジュール
|
|
||||||
- `Document` : ドキュメント関係
|
|
||||||
- WIP(JavaDocを参照してください, 余裕があったら追記します)
|
|
||||||
- `feature` : 機能モジュール(ナビゲーションからみた機能で分割)
|
- `feature` : 機能モジュール(ナビゲーションからみた機能で分割)
|
||||||
- `common`: 共通機能
|
- `common`: 共通機能
|
||||||
- 設定画面とか、どこからでも呼ばれうる画面
|
|
||||||
- `debug`: デバッグメニュー
|
- `debug`: デバッグメニュー
|
||||||
- `home`: ホーム画面
|
- `home`: ホーム画面
|
||||||
- `library`: ライブラリ画面
|
- `library`: ライブラリ画面
|
||||||
- `scan`: スキャン画面
|
- `scan`: スキャン画面 (廃止予定)
|
||||||
- `search`: 検索画面
|
- `search`: 検索画面
|
||||||
- `model` : モデル
|
- `model` : データモデルをまとめたモジュール
|
||||||
- データモデルをまとめたモジュール (WIP)
|
- `processor` : プロセッサ(例: `DocumentProcessor` : ドキュメント処理(ドキュメントにページを追加したり更新したり))
|
||||||
- `document` : ドキュメント
|
- `shared`: 共有リソース
|
||||||
- `meta` : メタデータ
|
- `ui`: UI要素(Theme, Drawable, Colorなど)
|
||||||
- `processor` : プロセッサ
|
- `source` : ソース(DB/FileManagerなど)
|
||||||
- いくつかの処理をまとめたモジュール
|
- `utils` : ユーティリティ(ちょっとしたユーティリティをまとめたモジュール)
|
||||||
- `DocumentProcessor` : ドキュメント処理(ドキュメントにページを追加したり更新したり)
|
|
||||||
- `shared` :
|
|
||||||
- 共有リソース
|
|
||||||
- `source` : ソース
|
|
||||||
- (バックエンドが使うのでとりあえず後回し、フロントから直接操作することは絶対にありません)
|
|
||||||
- `utils` : ユーティリティ
|
|
||||||
- ちょっとしたユーティリティをまとめたモジュール
|
|
||||||
- `LacertaLogger` : ロガー
|
|
||||||
- `XmlMetaParser` : XMLメタデータパーサー(フロントから直接操作することは絶対にありません)
|
|
||||||
|
|
||||||
|
|
||||||
## コーディング規則/推奨(WIP)
|
## コーディング規則/推奨(WIP)
|
||||||
### 規則
|
|
||||||
- `// TODO`コメントには任意のsuffixを付ける
|
- `// TODO`コメントには任意のsuffixを付ける
|
||||||
- 全員が同じ`// TODO:`を使っていると検索がむずかしくなるため
|
- 全員が同じ`// TODO:`を使っていると検索がむずかしくなるため
|
||||||
- (例: `// TODO-rca:`)
|
- (例: `// TODO-rca:`)
|
||||||
### 推奨
|
|
||||||
- マジックナンバーは控える(必要な場合もあるので)
|
|
||||||
|
|
||||||
|
## Thanks for
|
||||||
|
- [SDA-SE/document-scanner-android](https://github.com/SDA-SE/document-scanner-android)
|
||||||
|
-
|
||||||
|
|
Loading…
Reference in New Issue
Block a user