From 5eea7441b7d9d17d70aef714ea50c942207238d1 Mon Sep 17 00:00:00 2001
From: ORelio <oreliogitantispam.l0gin@spamgourmet.com>
Date: Mon, 6 Jul 2020 22:59:24 +0200
Subject: [PATCH] Add details on how to use BlockPaletteGenerator.cs (#1111)

---
 .../Mapping/BlockPalettes/BlockPaletteGenerator.cs   | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/MinecraftClient/Mapping/BlockPalettes/BlockPaletteGenerator.cs b/MinecraftClient/Mapping/BlockPalettes/BlockPaletteGenerator.cs
index ff267572..5dca47a3 100644
--- a/MinecraftClient/Mapping/BlockPalettes/BlockPaletteGenerator.cs
+++ b/MinecraftClient/Mapping/BlockPalettes/BlockPaletteGenerator.cs
@@ -9,6 +9,18 @@ namespace MinecraftClient.Mapping.BlockPalettes
     /// <summary>
     /// Generator for MCC Block Palette mappings
     /// </summary>
+    /// <remarks>
+    /// Example for generating MaterialXXX.cs and PaletteXXX.cs from blocks.json:
+    ///
+    /// MinecraftClient.Mapping.BlockPalettes.BlockPaletteGenerator.JsonToClass(
+    ///     @"C:\Path\To\blocks.json",
+    ///     @"C:\Path\To\Output\PaletteXXX.cs",
+    ///     @"C:\Path\To\Output\MaterialXXX.cs"
+    /// );
+    ///
+    /// Place the above example inside the Main() method of Program.cs, adjust paths then compile and run.
+    /// Do not forget to remove the temporay call to JsonToClass() from Main() once you are done.
+    /// </remarks>
     public static class BlockPaletteGenerator
     {
         /// <summary>