Skip to content

Commit 60d619c

Browse files
AZQ1994AZQ1994
committed
Link doc files
1 parent dc6aca5 commit 60d619c

10 files changed

+28
-0
lines changed

‎README.ja.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,11 @@
1010
- **馴染みの関連 API で高速参照**: `belongs_to` / `has_many` 風のインターフェースを DB ではなくオンメモリ上で処理し、N+1 を気にしなくてよい速度で動作。
1111
- **COW フレンドリーで多プロセス共有**: レコードは freeze され、Copy-on-Write を活かしてフォークプロセス間でメモリを効率共有できる。
1212

13+
## ドキュメント
14+
- 導入ガイド: [English](docs/simple_master_guide_en.md) / [日本語](docs/simple_master_guide_ja.md)
15+
- カラム仕様: [English](docs/simple_master_columns_en.md) / [日本語](docs/simple_master_columns_ja.md)
16+
- Dataset / Table: [English](docs/simple_master_dataset_en.md) / [日本語](docs/simple_master_dataset_ja.md)
17+
- Association: [English](docs/simple_master_associations_en.md) / [日本語](docs/simple_master_associations_ja.md)
18+
1319
## ライセンス
1420
MIT ライセンスです。詳細は [LICENSE](LICENSE) を参照してください。

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,11 @@ In game development and other domains, configuration/definition datasets are oft
99
- **Familiar associations, very fast**: `belongs_to` / `has_many`-style API resolved in memory, fast enough that N+1 is rarely a concern.
1010
- **COW-friendly for multi-process**: records are frozen, making Copy-on-Write efficient when sharing memory across forked processes.
1111

12+
## Documentation
13+
- Getting Started Guide: [English](docs/simple_master_guide_en.md) / [日本語](docs/simple_master_guide_ja.md)
14+
- Columns: [English](docs/simple_master_columns_en.md) / [日本語](docs/simple_master_columns_ja.md)
15+
- Dataset / Table: [English](docs/simple_master_dataset_en.md) / [日本語](docs/simple_master_dataset_ja.md)
16+
- Associations: [English](docs/simple_master_associations_en.md) / [日本語](docs/simple_master_associations_ja.md)
17+
1218
## License
1319
MIT License. See [LICENSE](LICENSE) for details.

‎docs/simple_master_associations_en.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Associations (English)
22

3+
> 日本語版: [simple_master_associations_ja.md](simple_master_associations_ja.md)
4+
35
## Overview
46
SimpleMaster provides `belongs_to`, `has_one`, `has_many`, and `has_many :through`.
57

‎docs/simple_master_associations_ja.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Association 仕様 (日本語)
22

3+
> English version: [simple_master_associations_en.md](simple_master_associations_en.md)
4+
35
## 全体説明
46
SimpleMaster の Association は `belongs_to` / `has_one` / `has_many` / `has_many :through` を提供します。
57

‎docs/simple_master_columns_en.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Columns (English)
22

3+
> 日本語版: [simple_master_columns_ja.md](simple_master_columns_ja.md)
4+
35
## Overview
46
SimpleMaster columns are defined with `def_column`. At load time, type conversion,
57
cache helpers, and accessor methods are generated.

‎docs/simple_master_columns_ja.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster カラム仕様 (日本語)
22

3+
> English version: [simple_master_columns_en.md](simple_master_columns_en.md)
4+
35
## 全体説明
46
SimpleMaster のカラムは `def_column` で定義し、ロード時に型変換・キャッシュ・補助メソッドを自動生成します。
57
`type` や各種 DSL によって、変換ルールや追加メソッドが決まります。

‎docs/simple_master_dataset_en.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Dataset / Table (English)
22

3+
> 日本語版: [simple_master_dataset_ja.md](simple_master_dataset_ja.md)
4+
35
## Overview
46
In SimpleMaster, the dataset holds the actual data, and each master class maps to a table.
57
The loader reads external data, and the table keeps records and caches.

‎docs/simple_master_dataset_ja.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Dataset / Table 仕様 (日本語)
22

3+
> English version: [simple_master_dataset_en.md](simple_master_dataset_en.md)
4+
35
## 全体説明
46
SimpleMaster ではデータの実体を `Dataset` が持ち、各 Master クラスごとに `Table` が対応します。
57
`Loader` が外部データを読み込み、`Table` がレコードと各種キャッシュを保持します。

‎docs/simple_master_guide_en.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster Getting Started Guide
22

3+
> 日本語版: [simple_master_guide_ja.md](simple_master_guide_ja.md)
4+
35
## Purpose
46
- Handle master data fast without relying on Rails/ActiveRecord
57
- Reference records as Ruby objects and define associations and caches

‎docs/simple_master_guide_ja.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SimpleMaster 導入ガイド
22

3+
> English version: [simple_master_guide_en.md](simple_master_guide_en.md)
4+
35
## 目的
46
- マスターデータを Rails/ActiveRecord とは別に高速に扱う
57
- Ruby オブジェクトとして参照でき、関連づけやキャッシュを定義できる

0 commit comments

Comments
 (0)