README.md
1### Usage
2
3To build dependencies for the current arch+OS:
4
5 make
6
7To build for another arch/OS:
8
9 make HOST=host-platform-triplet
10
11For example:
12
13 make HOST=x86_64-w64-mingw32 -j4
14
15A prefix will be generated that's suitable for plugging into Litecoin's
16configure. In the above example, a dir named x86_64-w64-mingw32 will be
17created. To use it for Litecoin:
18
19 ./configure --prefix=`pwd`/depends/x86_64-w64-mingw32
20
21Common `host-platform-triplets` for cross compilation are:
22
23- `i686-w64-mingw32` for Win32
24- `x86_64-w64-mingw32` for Win64
25- `x86_64-apple-darwin14` for macOS
26- `arm-linux-gnueabihf` for Linux ARM 32 bit
27- `aarch64-linux-gnu` for Linux ARM 64 bit
28- `riscv32-linux-gnu` for Linux RISC-V 32 bit
29- `riscv64-linux-gnu` for Linux RISC-V 64 bit
30
31No other options are needed, the paths are automatically configured.
32
33### Install the required dependencies: Ubuntu & Debian
34
35#### For macOS cross compilation
36
37 sudo apt-get install curl librsvg2-bin libtiff-tools bsdmainutils cmake imagemagick libcap-dev libz-dev libbz2-dev python-setuptools
38
39#### For Win32/Win64 cross compilation
40
41- see [build-windows.md](../doc/build-windows.md#cross-compilation-for-ubuntu-and-windows-subsystem-for-linux)
42
43#### For linux (including i386, ARM) cross compilation
44
45Common linux dependencies:
46
47 sudo apt-get install make automake cmake curl g++-multilib libtool binutils-gold bsdmainutils pkg-config python3 patch
48
49For linux ARM cross compilation:
50
51 sudo apt-get install g++-arm-linux-gnueabihf binutils-arm-linux-gnueabihf
52
53For linux AARCH64 cross compilation:
54
55 sudo apt-get install g++-aarch64-linux-gnu binutils-aarch64-linux-gnu
56
57For linux RISC-V 64-bit cross compilation (there are no packages for 32-bit):
58
59 sudo apt-get install g++-riscv64-linux-gnu binutils-riscv64-linux-gnu
60
61RISC-V known issue: gcc-7.3.0 and gcc-7.3.1 result in a broken `test_bitcoin` executable (see https://github.com/bitcoin/bitcoin/pull/13543),
62this is apparently fixed in gcc-8.1.0.
63
64### Dependency Options
65The following can be set when running make: make FOO=bar
66
67 SOURCES_PATH: downloaded sources will be placed here
68 BASE_CACHE: built packages will be placed here
69 SDK_PATH: Path where sdk's can be found (used by macOS)
70 FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up
71 NO_QT: Don't download/build/cache qt and its dependencies
72 NO_WALLET: Don't download/build/cache libs needed to enable the wallet
73 NO_UPNP: Don't download/build/cache packages needed for enabling upnp
74 DEBUG: disable some optimizations and enable more runtime checking
75 RAPIDCHECK: build rapidcheck (experimental)
76 HOST_ID_SALT: Optional salt to use when generating host package ids
77 BUILD_ID_SALT: Optional salt to use when generating build package ids
78
79If some packages are not built, for example `make NO_WALLET=1`, the appropriate
80options will be passed to litecoin's configure. In this case, `--disable-wallet`.
81
82### Additional targets
83
84 download: run 'make download' to fetch all sources without building them
85 download-osx: run 'make download-osx' to fetch all sources needed for macOS builds
86 download-win: run 'make download-win' to fetch all sources needed for win builds
87 download-linux: run 'make download-linux' to fetch all sources needed for linux builds
88
89### Other documentation
90
91- [description.md](description.md): General description of the depends system
92- [packages.md](packages.md): Steps for adding packages
93
94