diff --git a/README.md b/README.md index f65b60d..4bd087f 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,16 @@ If you're using [Central Package Management](https://learn.microsoft.com/en-us/n ``` ### C# -You'll need to enable C# documentation XML generation to ensure good analysis results. If your repo is not already using docxml globally, this can introduce a large number of errors and warnings specific to docxml. Additionally, turning on docxml adds additional output I/O that can slow down large repos. +You'll need to enable C# documentation XML generation to ensure good analysis results (RT0000 will fire if it's not enabled). If your repo is not already using docxml globally, this can introduce a large number of errors and warnings specific to docxml. Additionally, turning on docxml adds additional output I/O that can slow down large repos. -You can turn off specific docxml related warnings and errors while defaulting ReferenceTrimmer to off using a block of code like this in your `Directory.Build.props`. Turn on the ReferenceTrimmer build by setting `/p:EnableReferenceTrimmer=true` on the MSBuild command line or setting the same property value as an environment variable. You could create a separate build pipeline for your repo to run ReferenceTrimmer builds. +If your repo does not already set `` to `true`, add the following to your `Directory.Build.props` to enable it and suppress related warnings: ```xml - - - false - - + true -