summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorfireice-uk <fireice-uk@users.noreply.github.com>2017-10-04 21:54:48 +0100
committerfireice-uk <fireice-uk@users.noreply.github.com>2017-10-04 21:54:48 +0100
commit177f3e676cf9cee099606d4194cf2f9aec07c776 (patch)
tree5e54fe6b2c72749b0f0c19489e1dca2a830e833b /doc
parent8ee452eefae9be9d467602052131d3c5c9c0afb9 (diff)
downloadxmr-stak-177f3e676cf9cee099606d4194cf2f9aec07c776.zip
xmr-stak-177f3e676cf9cee099606d4194cf2f9aec07c776.tar.gz
Lots of little cleanup changes
Diffstat (limited to 'doc')
-rw-r--r--doc/compile.md6
-rw-r--r--doc/compile_FreeBSD.md7
-rw-r--r--doc/compile_Linux.md25
-rw-r--r--doc/tuning.md6
4 files changed, 30 insertions, 14 deletions
diff --git a/doc/compile.md b/doc/compile.md
index 04b1fe4..46d39cb 100644
--- a/doc/compile.md
+++ b/doc/compile.md
@@ -6,9 +6,9 @@
* [CPU Build Options](#cpu-build-options)
* [AMD Build Options](#amd-build-options)
* [NVIDIA Build Options](#nvidia-build-options)
-* [Compile in Windows](compile_Windows.md)
-* [Compile in Linux](compile_Linux.md)
-* [Compile in FreeBSD](compile_FreeBSD.md)
+* [Compile on Windows](compile_Windows.md)
+* [Compile on Linux](compile_Linux.md)
+* [Compile on FreeBSD](compile_FreeBSD.md)
## Build System
diff --git a/doc/compile_FreeBSD.md b/doc/compile_FreeBSD.md
index 6dd1165..34db1ca 100644
--- a/doc/compile_FreeBSD.md
+++ b/doc/compile_FreeBSD.md
@@ -10,9 +10,10 @@ From the root shell, run the following commands:
Type 'y' and hit enter to proceed with installing the packages.
- git clone https://github.com/fireice-uk/xmr-stak-cpu.git
- cd xmr-stak-cpu
- cmake .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake ..
make install
Now you have the binary located at "bin/xmr-stak" and the needed shared libraries.
diff --git a/doc/compile_Linux.md b/doc/compile_Linux.md
index 4947fd2..f0995b6 100644
--- a/doc/compile_Linux.md
+++ b/doc/compile_Linux.md
@@ -4,24 +4,36 @@
```
# Ubuntu / Debian
sudo apt install libmicrohttpd-dev libssl-dev cmake build-essential libhwloc-dev
- cmake .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake ..
make install
# Arch
sudo pacman -S base-devel hwloc openssl cmake libmicrohttpd
- cmake .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake ..
make install
# Fedora
sudo dnf install gcc gcc-c++ hwloc-devel libmicrohttpd-devel libstdc++-static make openssl-devel cmake
- cmake .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake ..
make install
# CentOS
sudo yum install centos-release-scl epel-release
sudo yum install cmake3 devtoolset-4-gcc* hwloc-devel libmicrohttpd-devel openssl-devel make
sudo scl enable devtoolset-4 bash
- cmake3 .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake3 ..
make install
# Ubuntu 14.04
@@ -33,7 +45,10 @@
cd /tmp/cmake-3.4.1/ && ./configure && make && sudo make install && cd -
sudo update-alternatives --install /usr/bin/cmake cmake /usr/local/bin/cmake 1 --force
sudo apt install libmicrohttpd-dev libssl-dev libhwloc-dev
- cmake .
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ cd xmr-stak/build
+ cmake ..
make install
```
diff --git a/doc/tuning.md b/doc/tuning.md
index 820fab5..806f059 100644
--- a/doc/tuning.md
+++ b/doc/tuning.md
@@ -43,11 +43,11 @@ To add a new GPU you need to add a new config set to `gpu_threads_conf`.
## AMD Backend
-By default the NVIDIA backend can be tuned in the config file `nvidia.txt`
+By default the AMD backend can be tuned in the config file `amd.txt`
### Choose `intensity` and `worksize`
-Intensity means the number of threads used to mine.
+Intensity means the number of threads used to mine. The maximum intensity is GPU_MEMORY_MB / 2 - 128, however for cards with 4GB and more, the optimum is likely to be lower than that.
`worksize` is the number of threads working together to increase the miner performance.
In the most cases a `worksize` of `16` or `8` is optimal.
@@ -64,4 +64,4 @@ To add a new GPU you need to add a new config set to `gpu_threads_conf` and incr
{ "index" : 0, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false },
{ "index" : 1, "intensity" : 1000, "worksize" : 8, "affine_to_cpu" : false },
],
-``` \ No newline at end of file
+```
OpenPOWER on IntegriCloud