Browse Source

Merge pull request #1604 from domosekai/docs

Yihong Wu 3 years ago
parent
commit
209f60f079
2 changed files with 38 additions and 8 deletions
  1. 37 0
      src/BUILD_WINDOWS.md
  2. 1 8
      vcpkg.json

+ 37 - 0
src/BUILD_WINDOWS.md

@@ -43,6 +43,19 @@ into it. So that is what will be described below.
   C:\vcpkg> vcpkg integrate install
   C:\vcpkg> vcpkg integrate install
   ```
   ```
 
 
+## Update
+
+- vcpkg
+
+  You are recommended to update vcpkg from time to time, so that the latest libraries are used in the build.
+
+  Go to the installation path, pull the latest repo and the binary:
+
+  ```
+  C:\vcpkg> git pull
+  C:\vcpkg> bootstrap-vcpkg.bat
+  ```
+  
 ## Building
 ## Building
 
 
 1. Launch Visual Studio
 1. Launch Visual Studio
@@ -55,6 +68,8 @@ into it. So that is what will be described below.
 
 
    **Note**: This step is not necessary if you have chosen **Clone a repository** as Visual Studio automatically takes care of it.
    **Note**: This step is not necessary if you have chosen **Clone a repository** as Visual Studio automatically takes care of it.
 
 
+1. Switch to folder view in the solution explorer
+
 1. Select a configuration from the dropdown menu below the search box. The default configurations are:
 1. Select a configuration from the dropdown menu below the search box. The default configurations are:
 
 
    - x64-native
    - x64-native
@@ -88,3 +103,25 @@ into it. So that is what will be described below.
    Run `vpnsetup.exe` to install desired components.
    Run `vpnsetup.exe` to install desired components.
 
 
 1. Congrats, you now have a complete CMake development environment for SoftEtherVPN on Windows, enjoy and happy contributing!
 1. Congrats, you now have a complete CMake development environment for SoftEtherVPN on Windows, enjoy and happy contributing!
+
+## Notes
+
+1. Build number
+
+   You can change the build number in `CMakeSettings.json`. Use any integer no less than 5180.
+
+   Delete and regenerate CMake cache after the change.
+
+1. 32-bit Windows
+
+   You don't need 32-bit Windows to build 32-bit executables. However, if 32-bit Windows is what you only have, things become a little complicated.
+
+   Visual Studio 2019 is the last version that works on 32-bit Windows. It does the job but its bundled CMake and Ninja are 64-bit versions.
+
+   After the installation of VS 2019, you need to download 32-bit CMake and Ninja and replace those that come with VS in:
+
+   ```
+   C:\Program Files\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\CMake
+   ```
+
+   Currently CMake has an official x86 installer but Ninja does not. You may need to download from a 3rd party or build from source.

+ 1 - 8
vcpkg.json

@@ -6,12 +6,5 @@
     "libsodium",
     "libsodium",
     "openssl",
     "openssl",
     "zlib"
     "zlib"
-  ],
-  "overrides": [
-    {
-      "name": "openssl",
-      "version-string": "1.1.1n"
-    }
-  ],
-  "builtin-baseline": "f6af75acc923c833a5620943e3fc7d5e4930f0df"
+  ]
 }
 }