diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/compile.md | 2 | ||||
-rw-r--r-- | doc/compile_MacOS.md | 31 | ||||
-rw-r--r-- | doc/compile_Windows.md | 8 | ||||
-rw-r--r-- | doc/usage.md | 4 |
4 files changed, 42 insertions, 3 deletions
diff --git a/doc/compile.md b/doc/compile.md index cf25135..4fa940f 100644 --- a/doc/compile.md +++ b/doc/compile.md @@ -9,6 +9,7 @@ * [Compile on Windows](compile_Windows.md) * [Compile on Linux](compile_Linux.md) * [Compile on FreeBSD](compile_FreeBSD.md) +* [Compile on MacOS](compile_MacOS.md) ## Build System @@ -30,6 +31,7 @@ After the configuration you need to compile the miner, follow the guide for your * [Compile in Windows](compile_Windows.md) * [Compile in Linux](compile_Linux.md) * [Compile in FreeBSD](compile_FreeBSD.md) +* [Compile in MacOS](compile_MacOS.md) ## Generic Build Options - `CMAKE_INSTALL_PREFIX` install miner to the home folder diff --git a/doc/compile_MacOS.md b/doc/compile_MacOS.md new file mode 100644 index 0000000..1b0af91 --- /dev/null +++ b/doc/compile_MacOS.md @@ -0,0 +1,31 @@ +# Compile **xmr-stak** for MacOS + +## Dependencies + +Assuming you already have [Homebrew](https://brew.sh) installed, the installation of dependencies is pretty straightforward and will generate the `xmr-stak` binary in the `bin/` directory. + +### For NVIDIA GPUs + +```shell +brew tap caskroom/drivers +brew cask install nvidia-cuda +brew install hwloc libmicrohttpd gcc openssl cmake +cmake . -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOpenCL_ENABLE=OFF +make install +``` + +[All available CMake options](compile.md#nvidia-build-options) + +### For AMD GPUs + +> 🖐 We need help with AMD GPU compilation instructions. Please submit a PR if you managed to install [AMD APP SDK](http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/) and to compile `xmr-stak` on MacOS. + +### For CPU-only mining + +```shell +brew install hwloc libmicrohttpd gcc openssl cmake +cmake . -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DCUDA_ENABLE=OFF -DOpenCL_ENABLE=OFF +make install +``` + +[All available CMake options](compile.md#cpu-build-options) diff --git a/doc/compile_Windows.md b/doc/compile_Windows.md index 532348c..dd7af1e 100644 --- a/doc/compile_Windows.md +++ b/doc/compile_Windows.md @@ -81,15 +81,19 @@ mkdir build cd build ``` - - with CUDA 8 + - for CUDA 8* ``` cmake -G "Visual Studio 15 2017 Win64" -T v140,host=x64 .. ``` - - with CUDA 9 + - for CUDA 9 and/or AMD GPUs, CPU ``` cmake -G "Visual Studio 15 2017 Win64" -T v141,host=x64 .. ``` ``` cmake --build . --config Release --target install cd bin\Release + copy C:\xmr-stak-dep\openssl\bin\* . ``` + +\* Miner is also compiled for AMD GPUs (if the AMD APP SDK is installed) and CPUs. +CUDA 8 requires a downgrade to the old v140 tool chain. diff --git a/doc/usage.md b/doc/usage.md index ca379ab..60825b4 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -20,7 +20,7 @@ The number of files depends on the available backends. 1) Double click the `xmr-stak.exe` file 2) Fill in the pool url, username and password -## Usage on Linux +## Usage on Linux & MacOS 1) Open a terminal within the folder with the binary 2) Start the miner with `./xmr-stak` @@ -40,6 +40,8 @@ Usage: xmr-stak [OPTION]... --cpu FILE CPU backend miner config file --noAMD disable the AMD miner backend --amd FILE AMD backend miner config file + --noNVIDIA disable the NVIDIA miner backend + --nvidia FILE NVIDIA backend miner config file The Following options temporary overwrites the config file settings: -o, --url URL pool url and port, e.g. pool.usxmrpool.com:3333 |