doc/build-windows.md

   1 WINDOWS BUILD NOTES
   2 ====================
   3
   4 Below are some notes on how to build Bitcoin Core for Windows.
   5
   6 Most developers use cross-compilation from Ubuntu to build executables for
   7 Windows. This is also used to build the release binaries.
   8
   9 While there are potentially a number of ways to build on Windows (for example using msys / mingw-w64),
  10 using the Windows Subsystem For Linux is the most straightforward. If you are building with
  11 another method, please contribute the instructions here for others who are running versions
  12 of Windows that are not compatible with the Windows Subsystem for Linux.
  13
  14 Compiling with Windows Subsystem For Linux
  15 -------------------------------------------
  16
  17 With Windows 10, Microsoft has released a new feature named the [Windows
  18 Subsystem for Linux](https://msdn.microsoft.com/commandline/wsl/about). This
  19 feature allows you to run a bash shell directly on Windows in an Ubuntu-based
  20 environment. Within this environment you can cross compile for Windows without
  21 the need for a separate Linux VM or server.
  22
  23 This feature is not supported in versions of Windows prior to Windows 10 or on
  24 Windows Server SKUs. In addition, it is available [only for 64-bit versions of
  25 Windows](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide).
  26
  27 To get the bash shell, you must first activate the feature in Windows.
  28
  29 1. Turn on Developer Mode
  30   * Open Settings -> Update and Security -> For developers
  31   * Select the Developer Mode radio button
  32   * Restart if necessary
  33 2. Enable the Windows Subsystem for Linux feature
  34   * From Start, search for "Turn Windows features on or off" (type 'turn')
  35   * Select Windows Subsystem for Linux (beta)
  36   * Click OK
  37   * Restart if necessary
  38 3. Complete Installation
  39   * Open a cmd prompt and type "bash"
  40   * Accept the license
  41   * Create a new UNIX user account (this is a separate account from your Windows account)
  42
  43 After the bash shell is active, you can follow the instructions below, starting
  44 with the "Cross-compilation" section. Compiling the 64-bit version is
  45 recommended but it is possible to compile the 32-bit version.
  46
  47 Cross-compilation
  48 -------------------
  49
  50 These steps can be performed on, for example, an Ubuntu VM. The depends system
  51 will also work on other Linux distributions, however the commands for
  52 installing the toolchain will be different.
  53
  54 First, install the general dependencies:
  55
  56     sudo apt-get install build-essential libtool autotools-dev automake pkg-config bsdmainutils curl
  57
  58 A host toolchain (`build-essential`) is necessary because some dependency
  59 packages (such as `protobuf`) need to build host utilities that are used in the
  60 build process.
  61
  62 ## Building for 64-bit Windows
  63
  64 To build executables for Windows 64-bit, install the following dependencies:
  65
  66     sudo apt-get install g++-mingw-w64-x86-64 mingw-w64-x86-64-dev
  67
  68 Then build using:
  69
  70     cd depends
  71     make HOST=x86_64-w64-mingw32
  72     cd ..
  73     ./autogen.sh # not required when building from tarball
  74     CONFIG_SITE=$PWD/depends/x86_64-w64-mingw32/share/config.site ./configure --prefix=/
  75     make
  76
  77 ## Building for 32-bit Windows
  78
  79 To build executables for Windows 32-bit, install the following dependencies:
  80
  81     sudo apt-get install g++-mingw-w64-i686 mingw-w64-i686-dev
  82
  83 Then build using:
  84
  85     cd depends
  86     make HOST=i686-w64-mingw32
  87     cd ..
  88     ./autogen.sh # not required when building from tarball
  89     CONFIG_SITE=$PWD/depends/i686-w64-mingw32/share/config.site ./configure --prefix=/
  90     make
  91
  92 ## Depends system
  93
  94 For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
  95
  96 Installation
  97 -------------
  98
  99 After building using the Windows subsystem it can be useful to copy the compiled
 100 executables to a directory on the windows drive in the same directory structure
 101 as they appear in the release `.zip` archive. This can be done in the following
 102 way. This will install to `c:\workspace\bitcoin`, for example:
 103
 104     make install DESTDIR=/mnt/c/workspace/bitcoin