summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/FAQ.md6
-rw-r--r--doc/compile_FreeBSD.md2
-rw-r--r--doc/compile_Linux.md7
-rw-r--r--doc/compile_Windows.md19
-rw-r--r--doc/tuning.md4
5 files changed, 20 insertions, 18 deletions
diff --git a/doc/FAQ.md b/doc/FAQ.md
index 0661073..aa6fb89 100644
--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@@ -44,10 +44,10 @@ Download and install this [runtime package](https://go.microsoft.com/fwlink/?Lin
## Error: MEMORY ALLOC FAILED: mmap failed
-On Linux you will need to configure large page support and increase your ulimit -l.
+On Linux you will need to configure large page support and increase your ulimit -l.
To set large page support, add the following lines to /etc/sysctl.conf:
-
+
vm.nr_hugepages=128
To increase the ulimit, add following lines to /etc/security/limits.conf:
@@ -55,7 +55,7 @@ To increase the ulimit, add following lines to /etc/security/limits.conf:
* soft memlock 262144
* hard memlock 262144
-You WILL need to log out and log back in for these settings to take affect on your user (no need to reboot, just relogin in your session).
+You WILL need to log out and log back in for these settings to take effect on your user (no need to reboot, just relogin in your session).
You can also do it Windows-style and simply run-as-root, but this is NOT recommended for security reasons.
diff --git a/doc/compile_FreeBSD.md b/doc/compile_FreeBSD.md
index 34db1ca..a4eb341 100644
--- a/doc/compile_FreeBSD.md
+++ b/doc/compile_FreeBSD.md
@@ -6,7 +6,7 @@
From the root shell, run the following commands:
- pkg install git libmicrohttpd hwloc cmake
+ pkg install git libmicrohttpd hwloc cmake
Type 'y' and hit enter to proceed with installing the packages.
diff --git a/doc/compile_Linux.md b/doc/compile_Linux.md
index 3eb4960..072402f 100644
--- a/doc/compile_Linux.md
+++ b/doc/compile_Linux.md
@@ -4,7 +4,8 @@
### AMD APP SDK 3.0 (only needed to use AMD GPUs)
-- download and install the latest version from [http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/](http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/)
+- download and install the latest version from https://www.dropbox.com/sh/mpg882ekirnsfa7/AADWz5X-TgVdsmWt0QwMgTWLa/AMD-APP-SDKInstaller-v3.0.130.136-GA-linux64.tar.bz2?dl=0
+ (do not wonder why it is a link to a dropbox but AMD has removed the SDK downloads, see https://community.amd.com/thread/228059)
### Cuda 8.0+ (only needed to use NVIDIA GPUs)
@@ -64,7 +65,7 @@
cd xmr-stak/build
cmake ..
make install
-
+
# TinyCore Linux 8.x
# TinyCore is 32-bit only, but there is an x86-64 port, known as "Pure 64,"
# hosted on the TinyCore home page, and it works well.
@@ -94,7 +95,7 @@
make install
```
-- g++ version 5.1 or higher is required for full C++11 support.
+- g++ version 5.1 or higher is required for full C++11 support.
If you want to compile the binary without installing libraries / compiler or just compile binary for some other distribution, please check the [build_xmr-stak_docker.sh script](scripts/build_xmr-stak_docker/build_xmr-stak_docker.sh).
- Some newer gcc versions are not supported by CUDA (e.g. Ubuntu 17.10). It will require installing gcc 5 but you can avoid changing defaults.
diff --git a/doc/compile_Windows.md b/doc/compile_Windows.md
index 129596c..802d5c5 100644
--- a/doc/compile_Windows.md
+++ b/doc/compile_Windows.md
@@ -13,7 +13,7 @@
- During install choose following components:
- `Desktop development with C++` (left side)
- `VC++ 2015.3 v140 toolset for desktop` (right side - **NOT** needed for CUDA 9 or AMD GPU)
- - Since release of VS2017 15.5 (12/04/17), require `VC++ 2017 version 15.4 v14.11 toolset` (under tab `Individual Components`, section `Compilers, build tools, and runtimes`), as CUDA 9.1 is not compatible with compiler 14.12.X
+ - Since release of VS2017 15.5 (12/04/17), require `VC++ 2017 version 15.4 v14.11 toolset` (under tab `Individual Components`, section `Compilers, build tools, and runtimes`), as CUDA 9.x is not compatible with compiler 14.12.X
### CMake for Win64
@@ -32,7 +32,8 @@
### AMD APP SDK 3.0 (only needed for AMD GPUs)
-- Download and install the latest version from http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/
+- Download and install the latest version from https://www.dropbox.com/s/gq8vqhelq0m6gj4/AMD-APP-SDKInstaller-v3.0.130.135-GA-windows-F-x64.exe
+ (do not wonder why it is a link to a dropbox but AMD has removed the SDK downloads, see https://community.amd.com/thread/222855)
### Dependencies OpenSSL/Hwloc and Microhttpd
- For CUDA 8*:
@@ -82,17 +83,17 @@
- Go to extracted source code directory (e.g. `cd C:\Users\USERNAME\xmr-stak-<version>`)
- Execute the following commands (NOTE: path to Visual Studio Community 2017 can be different)
```
- # Execute next line only if compiling for Cuda 9.1 and using Visual Studio 2017 >= 15.5 (released 12/04/17)
- "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" x64 -vcvars_ver=14.11
-
+ # Execute next line only if compiling for Cuda 9.x and using Visual Studio 2017 >= 15.5 (released 12/04/17)
+ "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" x64 -vcvars_ver=14.11
+
"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsMSBuildCmd.bat"
```
- Sometimes Windows will change the directory to `C:\Users\USERNAME\source\` instead of `C:\Users\USERNAME\xmr-stak-<version>\`. If that's the case execute `cd C:\Users\USERNAME\xmr-stak-<version>` followed by:
```
mkdir build
-
+
cd build
-
+
set CMAKE_PREFIX_PATH=C:\xmr-stak-dep\hwloc;C:\xmr-stak-dep\libmicrohttpd;C:\xmr-stak-dep\openssl
```
@@ -104,9 +105,9 @@
- Then execute
```
cmake --build . --config Release --target install
-
+
cd bin\Release
-
+
copy C:\xmr-stak-dep\openssl\bin\* .
```
- Miner is by default compiled for NVIDIA GPUs (if CUDA is installed), AMD GPUs (if the AMD APP SDK is installed) and CPUs.
diff --git a/doc/tuning.md b/doc/tuning.md
index 47ad0bb..6bf036e 100644
--- a/doc/tuning.md
+++ b/doc/tuning.md
@@ -82,10 +82,10 @@ If you are unsure of either GPU or platform index value, you can use `clinfo` to
```
"gpu_threads_conf" :
[
- { "index" : 0, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false,
+ { "index" : 0, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false,
"strided_index" : true, "mem_chunk" : 2, "comp_mode" : true
},
- { "index" : 1, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false,
+ { "index" : 1, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false,
"strided_index" : true, "mem_chunk" : 2, "comp_mode" : true
},
],
OpenPOWER on IntegriCloud