Update Windows build documentation (#4413)

This moves CMake to be our top supported build method, with Qt creator
being lower priority now.
This commit is contained in:
pajlada
2023-03-04 12:09:20 +01:00
committed by GitHub
parent 3c73801d20
commit 35ac9d5f22
3 changed files with 93 additions and 70 deletions
+20 -10
View File
@@ -1,28 +1,38 @@
# Building on Windows with vcpkg
This will require more than 30GB of free space on your hard drive.
## Prerequisites
1. Install [Visual Studio](https://visualstudio.microsoft.com/) with "Desktop development with C++" (~9.66 GB)
1. Install [CMake](https://cmake.org/) (~109 MB)
1. Install [git](https://git-scm.com/) (~264 MB)
1. Install [vcpkg](https://vcpkg.io/) (~80 MB)
1. Install [Visual Studio](https://visualstudio.microsoft.com/) with "Desktop development with C++"
1. Install [CMake](https://cmake.org/)
1. Install [git](https://git-scm.com/)
1. Install [vcpkg](https://vcpkg.io/)
- `git clone https://github.com/Microsoft/vcpkg.git`
- `cd .\vcpkg\`
- `.\bootstrap-vcpkg.bat`
- `.\vcpkg integrate install`
- `.\vcpkg integrate powershell`
- `cd ..`
1. Configure the environment for vcpkg
- `set VCPKG_DEFAULT_TRIPLET=x64-windows`
- [default](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md#additional-remarks) is `x86-windows`
- `set VCPKG_ROOT=C:\path\to\vcpkg\`
- `set PATH=%PATH%;%VCPKG_ROOT%`
1. Configure the environment variables for vcpkg.
Check [this document](https://gist.github.com/mitchmindtree/92c8e37fa80c8dddee5b94fc88d1288b#setting-an-environment-variable-on-windows) for more information for how to set environment variables on Windows.
- Ensure your dependencies are built as 64-bit
e.g. `setx VCPKG_DEFAULT_TRIPLET x64-windows`
See [documentation about Triplets](https://learn.microsoft.com/en-gb/vcpkg/users/triplets)
[default](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md#additional-remarks) is `x86-windows`
- Set VCPKG_ROOT to the vcpkg path
e.g. `setx VCPKG_ROOT <path to vcpkg>`
See [VCPKG_ROOT documentation](https://learn.microsoft.com/en-gb/vcpkg/users/config-environment#vcpkg_root)
- Append the vcpkg path to your path
e.g. `setx PATH "%PATH%;<path to vcpkg>"`
- For more configurations, see https://learn.microsoft.com/en-gb/vcpkg/users/config-environment
1. You may need to restart your computer to ensure all your environment variables and what-not are loaded everywhere.
## Building
1. Clone
- `git clone --recurse-submodules https://github.com/Chatterino/chatterino2.git`
1. Install dependencies (~21 GB)
1. Install dependencies
- `cd .\chatterino2\`
- `vcpkg install`
1. Build