From b23bc6ff9a80db708799f4d5d656b259e1b29765 Mon Sep 17 00:00:00 2001 From: hsu Date: Thu, 21 Dec 2023 20:49:05 +0800 Subject: [PATCH] Updated README --- README.md | 138 +++++++++++++++++++++++++++--------------------------- 1 file changed, 69 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 6ce550f..cabf404 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,15 @@ Use [Obfuscar.GlobalTool](https://www.nuget.org/packages/Obfuscar.GlobalTool) to ### Install Obfuscar.GlobalTool Global installation: -```bash -dotnet tool install --global Obfuscar.GlobalTool --version 2.2.38 -``` + ```bash + dotnet tool install --global Obfuscar.GlobalTool --version 2.2.38 + ``` Local installation: -```bash -dotnet new tool-manifest # if you are setting up this repo -dotnet tool install --local Obfuscar.GlobalTool --version 2.2.38 -``` + ```bash + dotnet new tool-manifest # if you are setting up this repo + dotnet tool install --local Obfuscar.GlobalTool --version 2.2.38 + ``` ### Install Hsu.Obfuscar.DotNetTool @@ -38,72 +38,72 @@ See [NuGet](https://www.nuget.org/packages/Hsu.Obfuscar.DotNetTool). ### Configuration - Add `AssemblySearchPath` file: -```csharp - - true - -``` -When you build the project, the `obfuscar.xml` file and `obfuscar.assemblies[-fw].xml` will be created to the `.obfuscar` folder. + ```csharp + + true + + ``` + + When you build the project, the `obfuscar.xml` file will be created to the root folder of project and `obfuscar.assemblies.xml` will be created to the output folder of project. - Default `obfuscar.xml` contents -```xml - - - - - - - - - - - - - - - - - - - - - - + ```xml + + + + + + + + + + + + + + + + + + - - - -``` - -- Default `obfuscar.assemblies[-fw].xml` contents -```xml - - - - -``` - -You can also modify the `obfuscar.xml` and `obfuscar.assemblies[-fw].xml` file to change the default values. - -### Generated files - -- Single framework - -```config --- .obfuscar - |-- obfuscar.xml - |-- obfuscar.assemblies.xml -``` - -- Multiple framework -```config --- .obfuscar - |-- obfuscar.xml - |-- obfuscar.assemblies-net462.xml - |-- obfuscar.assemblies-net6.0.xml - |-- obfuscar.assemblies-net8.0.xml -``` + + + + + + + + ``` + +- Default `obfuscar.assemblies.xml` contents + ```xml + + + + + ``` + + You can also modify the `obfuscar.xml` file to change the default values. + + You can also modify the `AssemblySearchNames` property will auto gen `AssemblySearchPath` in `obfuscar.assemblies.xml` file. + +- AssemblySearchNames + ```csharp + + Microsoft.CodeAnalysis.dll;Microsoft.CodeAnalysis.CSharp.dll + + ``` + +- `obfuscar.assemblies.xml` + ```xml + + + + + + ``` ## License MIT \ No newline at end of file