From d99440400996ffef842f2944900a0d7322a5abf8 Mon Sep 17 00:00:00 2001 From: Caelan Sayler Date: Mon, 22 Jan 2024 20:49:14 +0000 Subject: [PATCH] doc tweaks [no ci] --- README.md | 5 ++++- docs/bootstrapping.md | 30 +++++++++++++++--------------- docs/debugging.md | 9 ++++++++- docs/shortcuts.md | 15 +++++++++++++-- docs/signing.md | 2 +- 5 files changed, 41 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 822116b3..b6958308 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,10 @@ If you're not sure how these instructions fit into your app, check the example a - ❓ Ask questions, get support, or discuss ideas on [our Discord server](https://discord.gg/CjrCrNzd3F) - 🗣️ Report bugs on [GitHub Issues](https://github.com/velopack/velopack/issues) - ## Contributing - 💬 Join us on [Discord](https://discord.gg/CjrCrNzd3F) to get involved in dev discussions - 🚦 Read our [compiling guide](docs/compiling.md) + +## Testimonials +I have now got my external facing application using velopack. I am very impressed. Seems to work fabulously well and be much faster both in the initial build and in the upgrading of the software on the end user's machine than Squirrel was. I hope to go live with this late next week. It's amazing and the best installer I've ever used in over 30 years of development. Thanks so much! You are doing some great work! +[- Stefan (Discord)](https://discord.com/channels/767856501477343282/767856501477343286/1195642674078830613) \ No newline at end of file diff --git a/docs/bootstrapping.md b/docs/bootstrapping.md index 0c75a087..ba6f0800 100644 --- a/docs/bootstrapping.md +++ b/docs/bootstrapping.md @@ -24,21 +24,21 @@ Any of the following can be passed via the `--framework` argument. - `webview2` ### vcredist -- `vcredist100-x86` -- `vcredist100-x64` -- `vcredist110-x86` -- `vcredist110-x64` -- `vcredist120-x86` -- `vcredist120-x64` -- `vcredist140-x86` -- `vcredist140-x64` -- `vcredist141-x86` -- `vcredist141-x64` -- `vcredist142-x86` -- `vcredist142-x64` -- `vcredist143-x86` -- `vcredist143-x64` -- `vcredist143-arm64` +- `vcredist100-x86` (VC++ 10.0 / VS 2010) +- `vcredist100-x64` (VC++ 10.0 / VS 2010) +- `vcredist110-x86` (VC++ 11.0 / VS 2012) +- `vcredist110-x64` (VC++ 11.0 / VS 2012) +- `vcredist120-x86` (VC++ 12.0 / VS 2013) +- `vcredist120-x64` (VC++ 12.0 / VS 2013) +- `vcredist140-x86` (VC++ 14.0 / VS 2015) +- `vcredist140-x64` (VC++ 14.0 / VS 2015) +- `vcredist141-x86` (VC++ 14.1 / VS 2017) +- `vcredist141-x64` (VC++ 14.1 / VS 2017) +- `vcredist142-x86` (VC++ 14.2 / VS 2019) +- `vcredist142-x64` (VC++ 14.2 / VS 2019) +- `vcredist143-x86` (VC++ 14.3 / VS 2022) +- `vcredist143-x64` (VC++ 14.3 / VS 2022) +- `vcredist143-arm64` (VC++ 14.3 / VS 2022) ### .Net Framework - `net45` diff --git a/docs/debugging.md b/docs/debugging.md index a1e0db2a..ba3e66e8 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -12,6 +12,9 @@ You should provide an instance of `Microsoft.Extensions.Logging.ILogger` to `Vel For example: ```cs using Microsoft.Extensions.Logging; + +// ... + class ConsoleLogger : ILogger { public IDisposable BeginScope(TState state) where TState : notnull => null; @@ -19,13 +22,17 @@ class ConsoleLogger : ILogger public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) => Console.WriteLine(formatter(state, exception)); } + +// ... + +new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger()); ``` ### Update.exe & Setup.exe Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.md) for a comprehensive list of arguments supported. ### UpdateMac -All logs will be sent to `/tmp/velopack/{appid}.log`. +All logs will be sent to `/tmp/velopack.log`. ## Advanced Debugging The debug builds of Velopack binaries have additional logging/debugging capabilities, and will produce console output. In some instances, it may be useful to [compile Velopack](compiling.md) for your platform, and replace the release binaries of Setup.exe and Update.exe with debug versions. diff --git a/docs/shortcuts.md b/docs/shortcuts.md index 589dba2d..7c012f41 100644 --- a/docs/shortcuts.md +++ b/docs/shortcuts.md @@ -4,10 +4,21 @@ # Windows Shortcuts *Applies to: Windows* -By default, during installation Velopack will create a shortcut on the Desktop and in the Start Menu Root. +By default, during installation Velopack will create a shortcut on the Desktop and in the StartMenuRoot. It will automatically delete any shortcuts it finds when uninstalling the application. If you need to create shortcuts in any extra locations, the `Velopack.Windows.Shortcuts` and `Velopack.Windows.ShellLink` classes are provided. -These classes are provided for legacy reasons, and in general the stability of such functions is not guarenteed. \ No newline at end of file +These classes are provided for legacy reasons, and in general the stability of such functions is not guarenteed. + +For example, if you wished to create a shortcut during the install of your app, you might do the following: + +```cs +using Velopack; +using Velopack.Windows; + +VelopackApp.Build() + .WithAfterInstallFastCallback((v) => new Shortcuts().CreateShortcutForThisExe(ShortcutLocation.Desktop)) + .Run() +``` \ No newline at end of file diff --git a/docs/signing.md b/docs/signing.md index 8abf24a5..a3d93a13 100644 --- a/docs/signing.md +++ b/docs/signing.md @@ -11,7 +11,7 @@ On both platforms, signing needs to be performed by Velopack itself, this is bec ## Signing on Windows ### Acquiring a code signing certificate -First, you need to acquire a code-signing certificate from a reputable brand. To name a few: Digicert, Sectigo, Comodo. It may be possible to purchase a certificate through an official reseller for cheaper than buying directly from the issuer. If you are looking for an open source development certificate, Certum currently does an [Open Source Cloud Signing](https://certum.store/data-safety/code-signing-certificates.html?as_dane_w_certyfikacie=5720) certificate for $58 +First, you need to acquire a code-signing certificate from a reputable brand. To name a few: Digicert, Sectigo, Comodo. It may be possible to purchase a certificate through an official reseller for cheaper than buying directly from the issuer. If you are looking for an open source development certificate, at the time of writing Certum does an [Open Source Cloud Signing](https://certum.store/data-safety/code-signing-certificates.html?as_dane_w_certyfikacie=5720) certificate for $58. **Disclaimer: This is by no means a recommendation or advice for any particular code-signing certificate issuer, but instead is general guidance for the process one might follow to purchase a certificate.**