Merge pull request #73 from CyberAgentGameEntertainment/feature/readme

README for CompositeLayoutRuleData

Author: Haruma-K

README.md

@@ -61,6 +61,9 @@ And it also has the version management feature to exclude pre-release assets fro
 - [Create your own Asset Filters / Providers](#create-your-own-asset-filters--providers)
   - [Create your own Asset Filter](#create-your-own-asset-filter)
   - [Create your own Provider](#create-your-own-provider)
+- [Seamlessly Managing Multiple LayoutRuleData Assets](#seamlessly-managing-multiple-layoutruledata-assets)
+  - [How to Use](#how-to-use)
+  - [Validation](#validation-1)
 - [License](#license)
 
 </details>
@@ -769,6 +772,24 @@ Finally, press the **Change Provider** button of each **Provider** in **Layout R
   <img width="80%" src="Documentation/Images/custom_filter_provider_02.png" alt="Custom Provider">
 </p>
 
+## Seamlessly Managing Multiple LayoutRuleData Assets
+
+**CompositeLayoutRuleData** provides a way to transparently manage multiple `LayoutRuleData` assets, integrating and applying their layout rules as a single unit. When you apply a `CompositeLayoutRuleData` asset, all the layout rules from its configured `LayoutRuleData` assets are combined and applied together.
+
+### How to Use
+
+To create a `CompositeLayoutRuleData` asset, go to the Unity Editor menu and select **Assets > Create > Smart Addresser > Composite Layout Rule Data**.
+
+Once created, open the `CompositeLayoutRuleData` asset in the Inspector view. Here, you can configure the `Layout Rules` list by adding the `LayoutRuleData` assets you wish to integrate.
+
+To apply all the configured layout rules, simply click the **Apply** button at the top of the Inspector view. You can also set a `CompositeLayoutRuleData` asset as the `PrimaryData`, just like a regular `LayoutRuleData` asset.
+
+### Validation
+
+Validation can only be performed on individual `LayoutRuleData` assets. The `CompositeLayoutRuleData` itself does not detect conflicts or contradictions between multiple `LayoutRuleData` assets configured within it.
+
+Validation result files will be suffixed based on the index of the `LayoutRuleData` within the `CompositeLayoutRuleData`, for example: `[filename]_0.json`, `[filename]_1.json`, and so on.
+
 ## License
 This software is released under the MIT license.
 You are free to use it within the scope of the license, but the following copyright and license notices are required.

README_JA.md

@@ -64,6 +64,9 @@
 - [独自のアセットフィルタ、プロバイダを作成する](#%E7%8B%AC%E8%87%AA%E3%81%AE%E3%82%A2%E3%82%BB%E3%83%83%E3%83%88%E3%83%95%E3%82%A3%E3%83%AB%E3%82%BF%E3%83%97%E3%83%AD%E3%83%90%E3%82%A4%E3%83%80%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
   - [独自のアセットフィルタを作成する](#%E7%8B%AC%E8%87%AA%E3%81%AE%E3%82%A2%E3%82%BB%E3%83%83%E3%83%88%E3%83%95%E3%82%A3%E3%83%AB%E3%82%BF%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
   - [独自のプロバイダを作成する](#%E7%8B%AC%E8%87%AA%E3%81%AE%E3%83%97%E3%83%AD%E3%83%90%E3%82%A4%E3%83%80%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
+- [複数のLayoutRuleDataを透過的に扱う](#%E8%A4%87%E6%95%B0%E3%81%AElayoutruledata%E3%82%92%E9%80%8F%E9%81%8E%E7%9A%84%E3%81%AB%E6%89%B1%E3%81%86)
+  - [使い方](#%E4%BD%BF%E3%81%84%E6%96%B9)
+  - [バリデーション](#%E3%83%90%E3%83%AA%E3%83%87%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3)
 - [ライセンス](#%E3%83%A9%E3%82%A4%E3%82%BB%E3%83%B3%E3%82%B9)
 
 </details>
@@ -773,6 +776,23 @@ public sealed class ExampleAddressProvider : AddressProviderAsset
   <img width="80%" src="Documentation/Images/custom_filter_provider_02.png" alt="Custom Provider">
 </p>
 
+## 複数のLayoutRuleDataを透過的に扱う
+CompositeLayoutRuleData は、複数の LayoutRuleData を透過的に管理し、それらのレイアウトルールをまとめて適用するための機能です。  
+CompositeLayoutRuleData を適用すると、それに設定されている全ての LayoutRuleData のレイアウトルールが一括で適用されます。
+
+### 使い方
+Unityエディタのメニューから **Assets > Create > Smart Addresser > Composite Layout Rule Data** を選択し、アセットを作成します。  
+作成した CompositeLayoutRuleData アセットの Inspector ビューで、Layout Rules リストにまとめて適用したい LayoutRuleData アセットを設定します。
+
+Inspector ビュー上部にある Apply ボタンをクリックすると、設定した全てのレイアウトルールを適用します。  
+PrimaryData については、通常の LayoutRuleData と同様に CompositeLayoutRuleData を設定することが可能です。
+
+### バリデーション
+バリデーションは、個々の LayoutRuleData 単位でのみ実行可能です。  
+CompositeLayoutRuleData に設定された複数の LayoutRuleData 間で、互いに矛盾するレイアウトルールが存在する場合、CompositeLayoutRuleData 自体ではその矛盾は検知されません。
+
+バリデーション結果ファイルは、CompositeLayoutRuleData が持つ LayoutRuleData のインデックスに基づき、`[ファイル名]_0.json`、`[ファイル名]_1.json`のようにサフィックスが付与されます。
+
 ## ライセンス
 本ソフトウェアはMITライセンスで公開しています。  
 ライセンスの範囲内で自由に使っていただけますが、使用の際は以下の著作権表示とライセンス表示が必須となります。