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