diff --git a/docs/logic_blocks/02_installation.md b/docs/logic_blocks/02_installation.md index 9e0c589a..6006fdd2 100644 --- a/docs/logic_blocks/02_installation.md +++ b/docs/logic_blocks/02_installation.md @@ -21,6 +21,21 @@ Find the latest version number of LogicBlocks, its diagram generator, and the in Don't forget to include the `PrivateAssets="all"` and `OutputItemType="analyzer"` attributes on generator package references. ::: +:::caution +We strongly recommend treating warning `CS9057` as an error to catch possible compiler-mismatch issues with the Introspection generator. (See the [Introspection] README for more details.) To do so, add a `WarningsAsErrors` line to your `.csproj` file's `PropertyGroup`: + +```xml + + net8.0 + ... + + CS9057 + ... + +``` + +::: + :::tip Always use the same version of the LogicBlocks diagram generator that you use for LogicBlocks, since they are updated together. ::: @@ -29,3 +44,4 @@ Always use the same version of the LogicBlocks diagram generator that you use fo [Chickensoft.LogicBlocks.DiagramGenerator]: https://www.nuget.org/packages/Chickensoft.LogicBlocks.DiagramGenerator#versions-body-tab [Chickensoft.Introspection.Generator]: https://www.nuget.org/packages/Chickensoft.Introspection.Generator [Chickensoft.LogicBlocks]: https://www.nuget.org/packages/Chickensoft.LogicBlocks +[Introspection]: https://github.com/chickensoft-games/Introspection