Add documentation for all vendor binaries (closes #6)

This commit is contained in:
Caelan Sayler
2021-12-12 10:13:13 +00:00
parent 124ee4d227
commit 9e653e5984

40
vendor/README.md vendored Normal file
View File

@@ -0,0 +1,40 @@
# Vendor Binaries
This folder contains pre-compiled binaries from a variety of sources. These should be updated periodically.
### Microsoft.NET.HostModel.dll
- This is a .NET SDK 6.0.100 binary.
- It's purpose is to allow us to re-pack the `Update.exe` single file bundle with a new exe icon.
- Can be found in the dotnet SDK at "C:\Program Files\dotnet\sdk\6.0.100\Microsoft.NET.HostModel.dll".
- MIT License: https://github.com/dotnet/runtime/blob/main/LICENSE.TXT
### singlefilehost.exe
- This is the native exe that has the .net native runtime linked in.
- It is also used for re-packing the `Update.exe` binary.
- Can be found in the dotnet SDK at "C:\Program Files\dotnet\packs\Microsoft.NETCore.App.Host.win-x86\6.0.0\runtimes\win-x86\native\singlefilehost.exe".
- Can also be downloaded from NuGet, from here https://www.nuget.org/packages/Microsoft.NETCore.App.Host.win-x86/6.0.0
- MIT License: https://github.com/dotnet/runtime/blob/main/LICENSE.TXT
### nuget.exe
- Used with the `pack` command to bundle an application directory into a nuget package, which is then used to create Squirrel releases
- Can be found at https://www.nuget.org/downloads
- Apache 2.0 License: https://github.com/NuGet/NuGet.Client/blob/dev/LICENSE.txt
### rcedit.exe
- Updates PE resources, like VersionInfo or icons. It is used when generating `Setup.exe` and `Update.exe` to apply the user preferences.
- Can be found at https://github.com/electron/rcedit/releases
- MIT License: https://github.com/electron/rcedit/blob/master/LICENSE
### signtool.exe
- Signs application binaries while building Squirrel packages.
- Can be found in the Windows SDK at "C:\Program Files (x86)\Windows Kits\10\bin\10.0.19041.0\x86\signtool.exe" or similar, depending on the version of the SDK you have installed.
- License? https://github.com/dotnet/docs/issues/10478
### 7z.exe / 7z.dll
- Incldued because it is much faster at zipping / unzipping than the available managed algorithms.
- Can be found at https://www.7-zip.org/
- License is LGPL & BSD 3: https://www.7-zip.org/license.txt
### wix
- Can be used to build persistent msi packages for the purposes of AD deployment
- Can be found at https://github.com/wixtoolset/wix3/releases
- MS-RL License: https://github.com/wixtoolset/wix3/blob/develop/LICENSE.TXT