rixxc/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2025-12-04 15:39:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added Visual Studio build environment

Jonathan White
2022-03-10 22:02:21 -05:00
parent fb5194426d
commit efb97f36c1
1 changed files with 40 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
Set-up-Build-Environment-on-Windows.md

@@ -1,12 +1,47 @@
**Note:** This is only a one-time setup guide. For actually building KeePassXC, please refer to our [build guide](Building-KeePassXC).
## Setup Visual Studio Environment
We recommend building KeePassXC using Visual Studio to maximize feature availability. Visual Studio is free to use and dependencies are provided from trusted sources or self-built using Vcpkg.
### Install Visual Studio
1. Download and install Visual Studio Community 2022: https://visualstudio.microsoft.com/downloads/
2. At a minimum, ensure the following options are selected. We require at least Windows SDK version 10.0.22000.0. You can also import this installation configuration to auto-select these options: [vsconfig.zip](https://github.com/keepassxreboot/keepassxc/files/8228563/vsconfig.zip)
![image](https://user-images.githubusercontent.com/2809491/157791055-cf6c3ba1-b4d7-4f37-9284-d792c7e6378c.png)
3. (Optional) Instead of the entire IDE, you may install [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) and use [VSCode](https://code.visualstudio.com/download) as an IDE.
### Install Vcpkg and Dependencies
1. Download and install Vcpkg: https://vcpkg.io/en/getting-started.html
2. From the KeePassXC source directory, navigate to `utils\vcpkg_ports`. Copy all folders within this directory to your Vcpkg ports subfolder.
![image](https://user-images.githubusercontent.com/2809491/157793947-c248b8e1-e1e2-4872-8ffa-45691f1d3123.png)
2. Open a command prompt to the Vcpkg directory and run:
`.\vcpkg.exe install argon2 botan minizip qt5 qt5-svg qt5-tools qt5-imageformats readline zlib libqrencode --triplet=x64-windows`
### Install Asciidoctor
1. Download and install Ruby without devkit: https://rubyinstaller.org/downloads/
a. Make sure to **uncheck** install MSYS2/MINGW on the final install screen.
2. Open a command prompt and run: `gem install asciidoctor`
3. In the same command prompt, test the install by running: `asciidoctor`
## Setup MSYS Environment
_Building using MSYS is deprecated, we no longer recommend this method._
### Install the build environment
* Download MSYS2 64bit: http://msys2.github.io/
* Start MSYS2 shell
* Update the system packages: `pacman --needed -Sy bash pacman pacman-mirrors msys2-runtime`
* Restart MSYS2 shell
* Update all packages: `pacman -Syu` <br/>If tells you to close the shell, close and reupdate the package (until you are done)
* Update all packages: `pacman -Syu` <br/>If prompted, restart the shell and re-run this command until done
### Install the C++ toolchain
@@ -15,53 +50,19 @@ This command will install the MinGW-W GCC compiler, CMake and Binutils
Open an MSYS2 shell:
```
pacman -S git make mingw-w64-$(uname -m)-gcc \
pacman -S git make mingw-w64-$(uname -m)-gcc mingw-w64-$(uname -m)-toolchain \
mingw-w64-$(uname -m)-binutils mingw-w64-$(uname -m)-cmake
```
In addition, CLion needs
```
pacman -S mingw-w64-$(uname -m)-toolchain
```
to detect your Msys2 toolchain.
### Install the required dependencies
This command will install `qt5` `libgcrypt` and `zlib`
Open an MSYS2 shell:
```
pacman -S mingw-w64-$(uname -m)-qt5 \
mingw-w64-$(uname -m)-libgcrypt mingw-w64-$(uname -m)-zlib \
mingw-w64-$(uname -m)-argon2 mingw-w64-$(uname -m)-libsodium \
mingw-w64-$(uname -m)-qrencode mingw-w64-$(uname -m)-quazip \
mingw-w64-$(uname -m)-asciidoctor
```
If CMake is having trouble finding your compiler, make sure you have started the `MINGW64` environment and not the `MINGW32` or the generic `MSYS` environment. You need to have `/mingw64/bin` in your path.
### Install YubiKey libraries
If you do not want/need the Yubikey plugin (-DWITH_XC_YUBIKEY=OFF), you can skip this step.
#### Download libykpers
For compiling KeePassXC with YubiKey support, we need some extra libraries. To install them, run the following commands:
##### Windows 64-bit
```
pacman -Sy unzip
wget https://developers.yubico.com/yubikey-personalization/Releases/ykpers-1.19.0-win64.zip
unzip ykpers-1.*-win64.zip -d /mingw64/
```
##### Windows 32-bit
```
pacman -Sy unzip
wget https://developers.yubico.com/yubikey-personalization/Releases/ykpers-1.19.0-win32.zip
unzip ykpers-1.*-win32.zip -d /mingw32/
mingw-w64-$(uname -m)-libbotan mingw-w64-$(uname -m)-zlib \
mingw-w64-$(uname -m)-argon2 mingw-w64-$(uname -m)-libusb \
mingw-w64-$(uname -m)-qrencode mingw-w64-$(uname -m)-asciidoctor
```
### Packaging Requirements