Update README.md

Author: sator-imaging

README.md

@@ -21,11 +21,16 @@ As you already know, Roslyn's source generator is too sophisticated. This framew
 <p><details lang="en" --open><summary>Table of Contents</summary>
 
 - [Sample Code](#sample-code)
-    - [Result](#result)
-    - [Output Path](#output-path)
+    - [Method Generator](#method-generator)
+        - [How to Use](#how-to-use)
+        - [Result](#result)
+    - [Generic Generator](#generic-generator)
+        - [Result](#result-1)
+- [Output Directory and File Name](#output-directory-and-file-name)
 - [Utility Functions for Build](#utility-functions-for-build)
 - [Technical Notes](#technical-notes)
     - [Naming Convention](#naming-convention)
+    - [`<auto-generated/>` Tag](#auto-generated-tag)
 - [Installation](#installation)
 - [Editor Extensions](#editor-extensions)
 - [Copyright](#copyright)
@@ -35,9 +40,12 @@ As you already know, Roslyn's source generator is too sophisticated. This framew
 <!------- End of Details EN Tag -------></details></p>
 
 
+
+
+
 # Sample Code
 
-Minimal implementation of source generator here.
+Minimal implementation codes of source generator.
 
 <p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
 
@@ -46,14 +54,97 @@ Minimal implementation of source generator here.
 <!------- End of Details JA Tag -------></details></p>
 
 
+## Method Generator
+
+This example will add `Pacic()` method to target class.
+
+<p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
+
+ターゲットのクラスに `Panic()` メソッドを追加するサンプル。
+
+<!------- End of Details JA Tag -------></details></p>
+
+
+```csharp
+public class PanicMethodGenerator
+{
+    static string OutputFileName() => "PanicMethod.cs";  // -> PanicMethod.<TargetClass>.<GeneratorClass>.g.cs
+
+    static bool Emit(USGContext context, StringBuilder sb)
+    {
+        if (!context.TargetClass.IsClass || context.TargetClass.IsAbstract)
+            return false;  // return false to tell USG doesn't write file.
+
+        // code generation
+        sb.Append($@"
+namespace {context.TargetClass.Namespace}
+{{
+    internal partial class {context.TargetClass.Name}
+    {{
+        public void Panic() => throw new System.Exception();
+    }}
+}}
+");
+        return true;
+    }
+}
+```
+
+
+
+### How to Use
+
+
+```csharp
+using SatorImaging.UnitySourceGenerator;
+
+namespace Sample
+{
+    // Add attribute to target class to use method generator.
+    // Note that class must be defined as partial class.
+    [UnitySourceGenerator(typeof(PanicMethodGenerator), OverwriteIfFileExists = false)]
+    internal partial class MethodGeneratorSample
+    {
+    }
+
+}
+```
+
+### Result
+
+Generated code looks like this.
+
+```csharp
+// <auto-generated>PanicMethodGenerator</auto-generated>
+
+namespace Sample
+{
+    internal partial class MethodGeneratorSample
+    {
+        public void Panic() => throw new System.Exception();
+    }
+}
+```
+
+
+
+## Generic Generator
+
+Here is target-less generator example.
+
+It is useful to generate static database that cannot be generated on Unity runtime. For example, asset GUIDs database, resource integrity tables, etc.
+
+
+
+
 ```csharp
 using System.Text;
 using SatorImaging.UnitySourceGenerator;
 
 [UnitySourceGenerator(OverwriteIfFileExists = false)]
 class MinimalGenerator
 {
-    static string OutputFileName() => "Test.cs";  // USG automatically update to -> Test.<ClassName>.g.cs
+    static string OutputFileName() => "Test.cs";  // -> Test.<ClassName>.g.cs
 
     static bool Emit(USGContext context, StringBuilder sb)
     {
@@ -73,43 +164,36 @@ class MinimalGenerator
 
 
 
-## Result
-
-USG automatically adds document tag at the beginning of generated file. You can remove this document tag by `sb.Clear()` in `Emit()` method.
+### Result
 
 
-<p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
-
-書き出される内容は以下の通り。渡される `StringBuilder` の冒頭にはドキュメントタグが入ってます。
-
-<!------- End of Details JA Tag -------></details></p>
-
 ```csharp
 // <auto-generated>MinimalGenerator</auto-generated>
 Asset Path: Assets/Scripts/MinimalGenerator.cs
 Hello World from Sample.MinimalGenerator
 ```
 
 
+# Output Directory and File Name
 
-## Output Path
+Source Generator creates `USG.g` folder next to target script and append class names to file name.
 
-USG creates `USG.g` folder next to generator script file. Resulting file path will be:
+Resulting file path will be:
 
 - Assets/Scripts/<b>USG.g</b>/Test<b>.MinimalGenerator.g</b>.cs
+- Assets/Scripts/<b>USG.g</b>/PanicMethod<b>.MethodGeneratorSample.PanicMethodGenerator.g</b>.cs
 
 > NOTE: In above example, output path is modified so that resulting file name is `Test.MinimalGenerator.g.cs_MyFirstTest.txt`
 
 
 <p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
 
-書き出し先は上記の通り。フォルダーとジェネレータークラス名が付与されます。
+書き出し先は上記の通り。フォルダーとターゲット・ジェネレータークラス名が付与されます。
 
 <!------- End of Details JA Tag -------></details></p>
 
 
 
-
 # Utility Functions for Build
 
 There are utility functions to perform source code generation on build event.
@@ -172,6 +256,19 @@ As of C# 9.0, it doesn't allow to define `abstract static` methods in interface,
 
 
 
+## `<auto-generated/>` Tag
+
+USG automatically adds document tag at the beginning of generated file. You can remove this document tag by `sb.Clear()` in `Emit()` method.
+
+
+<p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
+
+渡される `StringBuilder` の冒頭にはドキュメントタグが入ってます。不要なら `sb.Clear()` してください。
+
+<!------- End of Details JA Tag -------></details></p>
+
+
+
 # Installation
 
 Use the following git URL in Unity Package Manager (UPM).
@@ -187,14 +284,15 @@ Use the following git URL in Unity Package Manager (UPM).
 
 手動でソースコード生成イベントの発火も可能です。「ジェネレーターのスクリプトファイル」か「生成されたファイル」を選択して、Project ウインドウで `Reimport` か `Unity Source Generator` 以下のメニューを実行します。
 
-`Force Generate...` はクラスアトリビュートの設定に関わらず強制的に上書き生成します。
+ジェネレーターとして参照されているファイルを Reimport した場合は、関連するクラスすべてが再生成されます。`Force Generate...` はクラスアトリビュートの設定に関わらず強制的に上書き生成します。
 
 <!------- End of Details JA Tag -------></details></p>
 
 There is an ability to invoke source code generation by hand. With generator script file or generated file selected in Project window:
 
 - `Reimport`
     - This command respects `OverwriteIfFileExists` setting by generator class attribute.
+    - Classes referencing selected generator will also be re-generated.
 
 - `Unity Source Generator > Force Generate`
     - This command will force re-generate source code even if overwrite setting is disabled.
@@ -250,6 +348,8 @@ SOFTWARE.
 
 
 
+
+
 &nbsp;  
 &nbsp;