summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTony Butler <spudz76@gmail.com>2018-05-03 16:00:58 +0100
committerTimothy Pearson <tpearson@raptorengineering.com>2018-06-04 21:07:11 +0000
commit7c587421f1050dac43d612b03f73c405928031b3 (patch)
treeb19a8938da8922ff02c047a5b35aebe6aecea428 /doc
parent84471e3d48b0423410384d41c2ce467b19f2b73a (diff)
downloadxmr-stak-7c587421f1050dac43d612b03f73c405928031b3.zip
xmr-stak-7c587421f1050dac43d612b03f73c405928031b3.tar.gz
Spell check
Diffstat (limited to 'doc')
-rw-r--r--doc/FAQ.md6
-rw-r--r--doc/compile_FreeBSD.md19
-rw-r--r--doc/compile_Linux.md45
-rw-r--r--doc/tuning.md4
4 files changed, 69 insertions, 5 deletions
diff --git a/doc/FAQ.md b/doc/FAQ.md
index a443e34..7feb62f 100644
--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@@ -9,10 +9,10 @@
## 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:
@@ -20,7 +20,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
new file mode 100644
index 0000000..a4eb341
--- /dev/null
+++ b/doc/compile_FreeBSD.md
@@ -0,0 +1,19 @@
+# Compile **xmr-stak** for FreeBSD
+
+## Install Dependencies
+
+*Note: This guide is tested for FreeBSD 11.0-RELEASE*
+
+From the root shell, run the following commands:
+
+ pkg install git libmicrohttpd hwloc cmake
+
+Type 'y' and hit enter to proceed with installing the packages.
+
+ 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 33a3fbf..4616c20 100644
--- a/doc/compile_Linux.md
+++ b/doc/compile_Linux.md
@@ -37,7 +37,52 @@ AMD ROCm should compile, but I cannot test it due to lack of hardware.
```
+ # Ubuntu 14.04
+ sudo add-apt-repository ppa:ubuntu-toolchain-r/test
+ sudo apt update
+ sudo apt install gcc-5 g++-5 make
+ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 1 --slave /usr/bin/g++ g++ /usr/bin/g++-5
+ curl -L http://www.cmake.org/files/v3.4/cmake-3.4.1.tar.gz | tar -xvzf - -C /tmp/
+ 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
+ git clone https://github.com/fireice-uk/xmr-stak.git
+ mkdir xmr-stak/build
+ 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.
+ # Beware that huge page support is not enabled in the kernel distributed
+ # with Pure 64. Consider http://wiki.tinycorelinux.net/wiki:custom_kernel
+ # Note that as of yet there are no distro packages for microhttpd or hwloc.
+ # hwloc is easy enough to install manually though, shown below.
+ # Also note that only CPU mining has been tested on this platform, thus the
+ # disabling of CUDA and OpenCL shown below.
+ tce-load -iw openssl-dev.tcz cmake.tcz make.tcz gcc.tcz git.tcz \
+ glibc_base-dev.tcz linux-4.8.1_api_headers.tcz \
+ glibc_add_lib.tcz
+ wget https://www.open-mpi.org/software/hwloc/v1.11/downloads/hwloc-1.11.8.tar.gz
+ tar xzvf hwloc-1.11.8.tar.gz
+ cd hwloc-1.11.8
+ ./configure --prefix=/usr/local
+ make
+ sudo make install
+ cd ..
+ git clone http://github.com/fireice-uk/xmr-stak
+ cd xmr-stak
+ mkdir build
+ cd build
+ CC=gcc cmake .. -DCUDA_ENABLE=OFF \
+ -DOpenCL_ENABLE=OFF \
+ -DMICROHTTPD_ENABLE=OFF
+ make install
+```
+
- IBM g++ version 6.3 or higher is required for full Altivec and 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).
### To do a generic and static build for a system without gcc 6.3+
diff --git a/doc/tuning.md b/doc/tuning.md
index 3f5dbfe..c4c39d8 100644
--- a/doc/tuning.md
+++ b/doc/tuning.md
@@ -77,10 +77,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