From c86d67be54500bd14b57bb9ec12e3fe90ec74ec9 Mon Sep 17 00:00:00 2001 From: JayDDee Date: Sun, 1 Mar 2020 23:48:44 -0500 Subject: [PATCH] Updated Getting started (markdown) --- Getting-started.md | 53 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/Getting-started.md b/Getting-started.md index d7de2a9..a6dd3dd 100644 --- a/Getting-started.md +++ b/Getting-started.md @@ -1 +1,52 @@ -# Requirements \ No newline at end of file +# Requirements + +## Hardware requirements. + +### CPU + +A x86_64 architecture CPU with a minimum of SSE2 support. This includes +Intel Core2 and newer and AMD equivalents. In order to take advantage of AES_NI +optimizations a CPU with AES_NI is required. This includes Intel Westmere +and newer and AMD equivalents. Further optimizations are available on some +algoritms for CPUs with AVX and AVX2, Sandybridge and Haswell respectively, +as well as AVX512, SHA, and VAES avaible on Icelake. + +Older CPUs are supported by cpuminer-multi by TPruvot but at reduced +performance. + +ARM, Aarch64, Raspberry Pi are not supported. + +### Memory + +Memory requirements are very dependant on the algorithm. Some algorithms require over 100 MB per thread. +GPU mining will also raise memory requirements. It's not a performance issue, it works smoothly or it +doesn't. + +## Software requirements + +### Operating system + +64 bit Linux OS. Ubuntu and Fedora based distributions, including Mint and +Centos, are known to work and have all dependencies in their repositories. +Others may work but may require more effort. Older versions such as Centos 6 +don't work due to missing features. +64 bit Windows OS is supported with mingw_w64 and msys or pre-built binaries. + +FreeBSD and other BSDs may work, YMMV. + +MacOS, OSx, Android, Haiku and reactOS are not supported. + +### Virtualization and Emulation + +It is possible to run cpuminer-opt in a virtual machine but some CPU features may be missing emulation. +CygWin has been known to work but has significantly lower performance than running a Windows binary natively. +VMs and emulators are nit recommended. + +### Server + +A stratum server for shared mode pool mining. Some pools also offer solo mining. + +A full node wallet for the coin to be mined using getwork. + +GBT is YMMV. +