aboutsummaryrefslogtreecommitdiff
path: root/contrib/depends/README.md
diff options
context:
space:
mode:
authorRiccardo Spagni <ric@spagni.net>2019-05-15 16:10:40 +0200
committerRiccardo Spagni <ric@spagni.net>2019-05-15 16:10:41 +0200
commite8487fa46b8a5a7b9b3f0322348168f19ea3a42a (patch)
tree715eb8ae1558c3018a35a8dbede2b3e4ebaf8ffa /contrib/depends/README.md
parentMerge pull request #5535 (diff)
parentChanged odd bullet point to low level header (diff)
downloadmonero-e8487fa46b8a5a7b9b3f0322348168f19ea3a42a.tar.xz
Merge pull request #5539
3f612cda Changed odd bullet point to low level header (Rohaq) af9bc4ec Used subeaders to avoid slightly wonky looking formatting (Rohaq) 1873af35 Made code block usage consistent across all .md files (Rohaq) 68103075 Updated Copyright notice (Rohaq) 39bd157f Added Table of Contents to main README.md (Rohaq)
Diffstat (limited to 'contrib/depends/README.md')
-rw-r--r--contrib/depends/README.md42
1 files changed, 27 insertions, 15 deletions
diff --git a/contrib/depends/README.md b/contrib/depends/README.md
index c9f8b0783..6a15055b4 100644
--- a/contrib/depends/README.md
+++ b/contrib/depends/README.md
@@ -2,21 +2,29 @@
To build dependencies for the current arch+OS:
- make
+```bash
+make
+```
To build for another arch/OS:
- make HOST=host-platform-triplet
+```bash
+make HOST=host-platform-triplet
+```
For example:
- make HOST=x86_64-w64-mingw32 -j4
+```bash
+make HOST=x86_64-w64-mingw32 -j4
+```
A toolchain will be generated that's suitable for plugging into Monero's
cmake. In the above example, a dir named x86_64-w64-mingw32 will be
created. To use it for Monero:
- cmake -DCMAKE_TOOLCHAIN=`pwd`/contrib/depends/x86_64-w64-mingw32
+```bash
+cmake -DCMAKE_TOOLCHAIN=`pwd`/contrib/depends/x86_64-w64-mingw32
+```
Common `host-platform-triplets` for cross compilation are:
@@ -31,20 +39,24 @@ No other options are needed, the paths are automatically configured.
Dependency Options:
The following can be set when running make: make FOO=bar
- SOURCES_PATH: downloaded sources will be placed here
- BASE_CACHE: built packages will be placed here
- SDK_PATH: Path where sdk's can be found (used by OSX)
- FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up
- DEBUG: disable some optimizations and enable more runtime checking
- HOST_ID_SALT: Optional salt to use when generating host package ids
- BUILD_ID_SALT: Optional salt to use when generating build package ids
+```
+SOURCES_PATH: downloaded sources will be placed here
+BASE_CACHE: built packages will be placed here
+SDK_PATH: Path where sdk's can be found (used by OSX)
+FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up
+DEBUG: disable some optimizations and enable more runtime checking
+HOST_ID_SALT: Optional salt to use when generating host package ids
+BUILD_ID_SALT: Optional salt to use when generating build package ids
+```
Additional targets:
- download: run 'make download' to fetch all sources without building them
- download-osx: run 'make download-osx' to fetch all sources needed for osx builds
- download-win: run 'make download-win' to fetch all sources needed for win builds
- download-linux: run 'make download-linux' to fetch all sources needed for linux builds
+```
+download: run 'make download' to fetch all sources without building them
+download-osx: run 'make download-osx' to fetch all sources needed for osx builds
+download-win: run 'make download-win' to fetch all sources needed for win builds
+download-linux: run 'make download-linux' to fetch all sources needed for linux builds
+```
#Darwin (macos) builds: