diff --git a/README.md b/README.md index 80aac95a..f8c069fa 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Built-in supported update download types: ## Getting Started - [Installing NetSparkle](#installing-netsparkle) +- [Trimming Your Application](#trimming-your-application) - [How Updates Work](#how-updates-work) - [Basic Usage](#basic-usage) - [App Cast](#app-cast) @@ -56,6 +57,16 @@ Quick info for tool installations: * App cast generator -- `dotnet tool install --global NetSparkleUpdater.Tools.AppCastGenerator`; available as `netsparkle-generate-appcast` on your command line after installation * DSA Helper -- `dotnet tool install --global NetSparkleUpdater.Tools.DSAHelper`; available as `netsparkle-dsa` on your command line after installation +## Trimming your application + +[Trimming](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trimming-options) is a great way to reduce the file size of your application when it is self-published and/or built as a self-contained application. In short, trimming removes unused code from your applications, including external libraries, so you can ship your application with a reduced file size. To trim your application on publish, add `true` to your `csproj` file. If you want to trim all assemblies (including those that may not have specified they are compatible with trimming), add `full` to your `csproj` file; to only trim those that have opted-in, use `partial`. To enable warnings for trimming, add `false`. + +There are other options to use, which you can learn more about on Microsoft's documentation [here](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trimming-options). For those applications that may not work with the built-in trimming options, please try [Zack.DotNetTrimmer](https://github.com/yangzhongke/Zack.DotNetTrimmer) or other solutions you may find. + +We recommend that you trim your application before publishing it and distributing it to your users. Some of NetSparkle's default dependencies are rather large, but the file size can be drastically reduced by the trim process. If you choose to trim your application, don't forget to test it after trimming and make sure you fix any warnings that come up! And, in particular, if you wish to reduce the size of NetSparkle's BouncyCastle dependency, you can feel free to trim the library on your own (e.g. via a quick sample project as [outlined here](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/prepare-libraries-for-trimming#show-all-warnings-with-test-app)) and then replace the DLL that NetSparkle ships with with the one you built — just remember to test afterwards! + +You can also read more about trimming libraries [here](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/prepare-libraries-for-trimming). + ## How updates work A typical software update path for a stereotypical piece of software might look like this: diff --git a/src/NetSparkle.Tools.AppCastGenerator/NetSparkle.Tools.AppCastGenerator.csproj b/src/NetSparkle.Tools.AppCastGenerator/NetSparkle.Tools.AppCastGenerator.csproj index 5e0d99a2..40e7d885 100644 --- a/src/NetSparkle.Tools.AppCastGenerator/NetSparkle.Tools.AppCastGenerator.csproj +++ b/src/NetSparkle.Tools.AppCastGenerator/NetSparkle.Tools.AppCastGenerator.csproj @@ -70,8 +70,7 @@ runtime; build; native; contentfiles; analyzers; buildtransitive all - - + diff --git a/src/NetSparkle/NetSparkle.csproj b/src/NetSparkle/NetSparkle.csproj index 4cacb3f9..a4328168 100644 --- a/src/NetSparkle/NetSparkle.csproj +++ b/src/NetSparkle/NetSparkle.csproj @@ -98,8 +98,7 @@ - - +