Cleanup - unused files / unused exports / duplicate exports
[ProtonMail-WebClient.git] / packages / shared / lib / squirrel / README.md
blob8df1891a32b4e2872eb78684df43295e401da01c
1 # Custom build of Squirrel
3 If you want to use custom vendor in your project you have to set the path in forge config
5 ```typescript
6 const config: ForgeConfig = {
7     makers: [
8         {
9             name: '@electron-forge/maker-squirrel',
10             config: {
11                 vendorDirectory: `${__dirname}/../../packages/shared/lib/squirrel/assets`,
12             },
13         },
14     ],
16 ```
18 ## Before building
20 -   Installing 2019 version v142 and .NET 4.5
21     ```
22     choco install visualstudio2019buildtools
23     ```
24 -   modify -> add these:
25     -   Workloads:
26         -   `Desktop development C++`
27         -   `.NET desktop build tools`
28     -   Individual:
29         -   `.NET SDK (out of support)`
30         -   `C++ ATL for latest v142 build tools (x86 & x64)`
31         -   `.NET Framework 3.5 development tools`
32 -   In windows `Sever Manager` we need to add feature `.NET Framework 3.5 features`
34 ## To build
36 Clone fork https://github.com/ProtonMail/Squirrel.Windows `cd` to project and run
38 ```
39 .\devbuild.cmd release
40 ```
42 ## Update vendor files
44 Only these are necessary to change:
46 ```
47 .rw------- 1.8 MB Wed Aug 28 16:00:13 2024  Squirrel-Mono.exe
48 .rw-------  21 KB Wed Aug 28 16:00:13 2024 󰪪 Squirrel-Mono.pdb
49 .rw------- 7.5 KB Wed Aug 28 16:00:13 2024  Squirrel.com
50 .rw------- 1.8 MB Wed Aug 28 16:00:13 2024  Squirrel.exe
51 .rw-------  22 KB Wed Aug 28 16:00:13 2024 󰪪 Squirrel.pdb
52 ```
54 After build the files are in `build/Release/net45`.
56 Copy files to temp `cp update.com Update{,-Mono}.{exe,pdb} /tmp/`
58 ```
59 rename update Squirrel /tmp/update*
60 rename Update Squirrel /tmp/Update*
61 ```
63 And move them to `./assets/` folder.