Merge pull request #2601 from fireice-uk/xmr-stak-rx-dev

release 1.0.2-rx

CMakeLists.txt

@@ -488,39 +488,39 @@ if(CUDA_FOUND)
     if(CUDA_COMPILER STREQUAL "clang")
         # build device code with clang
         add_library(
-            xmrstak_cuda_backend
+            xmrstakrx_cuda_backend
             SHARED
             ${CUDASRCFILES}
         )
-        set_target_properties(xmrstak_cuda_backend PROPERTIES COMPILE_FLAGS ${CLANG_BUILD_FLAGS})
-        set_target_properties(xmrstak_cuda_backend PROPERTIES LINKER_LANGUAGE CXX)
+        set_target_properties(xmrstakrx_cuda_backend PROPERTIES COMPILE_FLAGS ${CLANG_BUILD_FLAGS})
+        set_target_properties(xmrstakrx_cuda_backend PROPERTIES LINKER_LANGUAGE CXX)
         set_source_files_properties(${CUDASRCFILES} PROPERTIES LANGUAGE CXX)
     else()
         #  build device code with nvcc
         cuda_add_library(
-            xmrstak_cuda_backend
+            xmrstakrx_cuda_backend
             SHARED
             ${CUDASRCFILES}
         )
     endif()
 
     set(CUDA_LIBRARIES ${CUDA_LIBRARIES})
 
-    target_link_libraries(xmrstak_cuda_backend ${CUDA_LIBRARIES})
-    target_link_libraries(xmrstak_cuda_backend xmr-stak-backend)
+    target_link_libraries(xmrstakrx_cuda_backend ${CUDA_LIBRARIES})
+    target_link_libraries(xmrstakrx_cuda_backend xmr-stak-backend)
 endif()
 
 # compile AMD backend
 if(OpenCL_FOUND)
     file(GLOB OPENCLSRCFILES
         "xmrstak/backend/amd/amd_gpu/*.cpp"
         "xmrstak/backend/amd/*.cpp")
-    add_library(xmrstak_opencl_backend
+    add_library(xmrstakrx_opencl_backend
         SHARED
         ${OPENCLSRCFILES}
     )
-    target_link_libraries(xmrstak_opencl_backend ${OpenCL_LIBRARY} )
-    target_link_libraries(xmrstak_opencl_backend xmr-stak-backend)
+    target_link_libraries(xmrstakrx_opencl_backend ${OpenCL_LIBRARY} )
+    target_link_libraries(xmrstakrx_opencl_backend xmr-stak-backend)
 endif()
 
 # compile final binary
@@ -548,19 +548,19 @@ if( NOT CMAKE_INSTALL_PREFIX STREQUAL PROJECT_BINARY_DIR )
             RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/${EXECUTABLE_OUTPUT_PATH}")
     if(CUDA_FOUND)
         if(WIN32)
-            install(TARGETS xmrstak_cuda_backend
+            install(TARGETS xmrstakrx_cuda_backend
                 RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/${LIBRARY_OUTPUT_PATH}")
         else()
-            install(TARGETS xmrstak_cuda_backend
+            install(TARGETS xmrstakrx_cuda_backend
                 LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/${LIBRARY_OUTPUT_PATH}")
         endif()
     endif()
     if(OpenCL_FOUND)
         if(WIN32)
-            install(TARGETS xmrstak_opencl_backend
+            install(TARGETS xmrstakrx_opencl_backend
                 RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/${LIBRARY_OUTPUT_PATH}")
         else()
-            install(TARGETS xmrstak_opencl_backend
+            install(TARGETS xmrstakrx_opencl_backend
                 LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/${LIBRARY_OUTPUT_PATH}")
         endif()
     endif()

README.md

@@ -1,82 +1,10 @@
-###### fireice-uk's and psychocrypt's
-# XMR-Stak-RX: Free RandomX Mining Software
-
-XMR-Stak-RX is a universal free and open source stratum pool miner. This miner supports x86-64 CPUs, AMD and NVIDIA GPUs and can be used for various randomX variants.
-
-## Video guides
-[<img src="doc/_img/stak-yt-cover.jpg">](https://www.youtube.com/playlist?list=PLAhUkom29iGMFoN8pk91JA-oqvxlmJ5H8)
-###### Video by Crypto Sewer
-
-## Overview
-* [Features](#features)
-* [Supported coins and algorithms](#supported-coins-and-algorithms)
-* [Download](#download)
-* [FAQ](doc/FAQ.md)
-* [Developer Donation](#developer-donation)
-* [Developer PGP Key's](doc/pgp_keys.md)
-
-## Guides and FAQ
-To improve our support we created [Xmr-Stak forum](https://www.reddit.com/r/XmrStak). Check it out if you have a problem, or you are looking for most up to date config for your card and [guides](https://www.reddit.com/r/XmrStak/wiki/index).
-* [Usage](doc/usage.md)
-* [How to compile](doc/compile/compile.md)
-* [Fine tuning](doc/tuning.md)
-* [FAQ](doc/FAQ.md)
-* [Troubleshooting](doc/troubleshooting.md) (Fixing common problems)
-
-## Features
-
-- Supports all common backends (CPU/x86, AMD/NVIDIA GPU).
-- Supports all common OS (Linux, Windows and macOS).
-- Supports `randomx`, `randomx_loki` and `randomx_wow`
-- Easy to use and flexible in setup:
-  - guided start with easy/advanced setup option (no need to edit a config file for the first start)
-  - auto-configuration and config file creation for each backend.
-- Open source software (GPLv3)
-- TLS support.
-- [HTML statistics](doc/usage.md#html-and-json-api-report-configuraton)
-- [JSON API for monitoring](doc/usage.md#html-and-json-api-report-configuraton)
-
-## HTML reports
-  <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-hashrate.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-results.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-connection.png" width="260">
-
-## Supported coins and algorithms
-
-Following coins can be mined using this miner:
-
-- [Loki]()
-- [Monero](https://getmonero.org)
-- [WOW]()
-
-
-**[Ryo Currency](https://ryo-currency.com)** - is a way for us to implement the ideas that we were unable to in
-Monero. See [here](https://github.com/fireice-uk/cryptonote-speedup-demo/) for details.
-
-If your preferred coin is not listed, you can choose one of the following mining algorithms:
-
-- 1MiB scratchpad memory
-    - randomx_wow
-
-
-- 2MiB scratchpad memory
-    - randomx
-    - randomx_loki
-
-Please note, this list is not complete and is not an endorsement.
-
-## Download
-
-You can find the latest releases and precompiled binaries on GitHub under [Releases](https://github.com/fireice-uk/xmr-stak/releases).
-
-## Developer Donation
-
-If you want to donate directly to support further development, here are our wallets
-
-fireice-uk:
-```
-4581HhZkQHgZrZjKeCfCJxZff9E3xCgHGF25zABZz7oR71TnbbgiS7sK9jveE6Dx6uMs2LwszDuvQJgRZQotdpHt1fTdDhk
-```
-
-psychocrypt:
-```
-45tcqnJMgd3VqeTznNotiNj4G9PQoK67TGRiHyj6EYSZ31NUbAfs9XdiU5squmZb717iHJLxZv3KfEw8jCYGL5wa19yrVCn
-```
+<a href="https://github.com/fireice-uk/xmr-stak/tree/master/doc/README.md" _target="blank"><img src="doc/_img/gpu.png"></a>
+<a href="#select_coin" _target="blank"><img src="doc/_img/cpu.png"></a>
+<table>
+    <p id="select_coin">
+    <tr>
+        <td align="center"><a href=https://github.com/xmrig/xmrig><img src="doc/_img/xmrig.png"></a></td>
+        <td align="center"><a href=https://ragerx.lol><img src="doc/_img/ragerx.png"></a></td>
+        <td align="center"><a href=doc/README.md><img src="doc/_img/rx.png"></a></td>
+    </tr>
+</table>

doc/FAQ.md

@@ -1,5 +1,5 @@
 # FAQ
-To improve our support we created [Xmr-Stak forum](https://www.reddit.com/r/XmrStak). Check it out if you have a problem, or you are looking for most up to date config for your card and [guides](https://www.reddit.com/r/XmrStak/wiki/index).
+To improve our support we created [Xmr-Stak-RX forum](https://www.reddit.com/r/XmrStak). Check it out if you have a problem, or you are looking for most up to date config for your card and [guides](https://www.reddit.com/r/XmrStak/wiki/index).
 
 
 ## Content Overview
@@ -10,13 +10,13 @@ To improve our support we created [Xmr-Stak forum](https://www.reddit.com/r/XmrS
 
 ### Virus Protection Alert
 Some virus protection software flags the miner binary as *malware*. This is a false positive — the software does not contain any malware (and since it is open source, you can verify that yourself!)
-If your antivirus software flags **xmr-stak**, it will likely move it to its quarantine area. You may have to whitelist **xmr-stak** in your antivirus.
+If your antivirus software flags **xmr-stak-rx**, it will likely move it to its quarantine area. You may have to whitelist **xmr-stak-rx** in your antivirus.
 
 ### Change Currency to Mine
 If the miner is compiled for Monero and Aeon than you can change
  - the value `currency` in the config *or*
  - start the miner with the [command line option](usage.md) `--currency monero` or `--currency aeon7`
- - run `xmr-stak --help` to see all supported currencies and algorithms
+ - run `xmr-stak-rx --help` to see all supported currencies and algorithms
 
 ### How can I mine Monero
 Set the value `currency` in `pools.txt` to `monero`.

doc/README.md

@@ -0,0 +1,90 @@
+<table>
+    <tr>
+        <td align="center"><a href=#><img src="/doc/_img/xmr-stak-rx-btn.png"></a></td>
+        <td align="center"><a href=https://github.com/fireice-uk/xmr-stak/tree/master/doc/README.md><img src="/doc/_img/xmr-stak-btn.png"></a></td>
+        <td align="center"><a href=https://ragerx.lol><img src="/doc/_img/ragerx-btn.png"></a></td>
+    </tr>
+</table>
+
+<table>
+    <tr>
+        <td align="center"><a href=#features-overview><img src="/doc/_img/menu-features.png"></a></td>
+        <td align="center"><a href=#supported-coins-and-randomx-variants><img src="/doc/_img/menu-supported-coins.png"></a></td>
+        <td align="center"><a href=#Donations><img src="/doc/_img/menu-donations.png"></a></td>
+        <td align="center"><a href=#get-miner><img src="/doc/_img/menu-get-miner.png"></a></td>
+        <td align="center"><a href=#support-additional-guides-and-feedback><img src="/doc/_img/menu-support.png"></a></td>
+    </tr>
+</table>
+
+<table>
+    <tr>
+        <td align="center"><a href=usage.md><img src="/doc/_img/usage.png"></a></td>
+        <td align="center"><a href=compile/compile.md><img src="/doc/_img/how-to-compile.png"></a></td>
+        <td align="center"><a href=tuning.md><img src="/doc/_img/fine-tuning.png"></a></td>
+        <td align="center"><a href=troubleshooting.md><img src="/doc/_img/troubleshooting.png"></a></td>
+        <td align="center"><a href=FAQ.md><img src="/doc/_img/faq.png"></a></td>
+    </tr>
+</table>
+
+## Features overview
+[<img src="/doc/_img/features.png">](#)
+
+
+### Supported coins and RandomX variants
+Xmr-Stak-RX supports various variants of RandomX algorithm. Use one of the following options (type this coin alias in either `pool.txt` config file or on startup configuration under `"currency"` parameter and miner will pick it's variant of RandomX algorithm for mining):
+
+| Coin name | Coin alias in config | POW type |
+| --- | --- |  --- |
+| Monero | `monero` | RandomX |
+| Loki Network | `loki` | RandomXL |
+| Wownero (Monero's testnet) | `wownero` | RandomWOW |
+
+
+## Donations
+[<img src="/doc/_img/fee.png">](#)
+
+## Get Miner
+Please note that code is developed on the [dev branch](#), if you want to check out the latest updates, before they are merged on [main branch](#), please refer there. Master branch will always point to a version that we consider stable, so you can download the code by simply typing `git clone https://github.com/fireice-uk/xmr-stak-rx.git`  
+
+Also you can find the latest releases, changelog and precompiled binaries on GitHub under [releases](#) section.
+
+If you want to compile the miner from source files, navigate to ["how to compile"](#) section of docs or [xmr-stak forum](#) where you will find the latest step-by-step instructions.
+
+
+## Start Mining
+Miner has 2 ways of initial configuring: simple and advanced. The simple method will prompt user with minimum information. Required answers are y , (or yes), n , (or no):
+
+#### Simple setup:
+* `Use simple setup method?` y    
+* `Please enter the currency that you want to mine:` Enter currency or mining algorithm  
+* `Enter pool address (pool address:port):` Enter pool connection address:port  
+* `Username (wallet address or pool login):` Enter wallet address
+* `Password (mostly empty or x):` press Enter  
+* `Does this pool port support TLS/SSL? Use no if unknown. (y/N):` press y or n  
+
+#### Advanced setup:
+* `Use simple setup method?` n  
+* `Do you want to use the HTTP interface? Unlike the screen display, browser interface is not affected by the GPU lag. If you don't want to use it, please enter 0, otherwise enter port number that the miner should listen on` 5656
+* `Please enter the currency that you want to mine:` Enter currency or mining algorithm
+* `Enter pool address (pool address:port):` Enter pool connection address:port 
+* `Username (wallet address or pool login):` Enter wallet address
+* `Password (mostly empty or x):` press Enter
+* `Rig identifier for pool-side statistics (needs pool support). Can be empty:` Enter rig name or press Enter
+* `Does this pool port support TLS/SSL? Use no if unknown. (y/N)` Enter y or n
+* `Do you want to use nicehash on this pool? (y/N)` n
+* `Do you want to use multiple pools? (y/N)` Enter y if you want to se up backup pool or n
+
+
+## Support additional guides and feedback
+[<img src="/doc/_img/YT.png">](#)
+To improve our support we created [Xmr-Stak forum](https://www.reddit.com/r/XmrStak) which is also applicable to Xmr-Stak-RX. Check it out if you have a problem, or you are looking for most up to date config for your card and [guides](https://www.reddit.com/r/XmrStak/wiki/index).
+
+<table>
+    <tr>
+        <td align="center"><a href=usage.md><img src="/doc/_img/usage.png"></a></td>
+        <td align="center"><a href=compile/compile.md><img src="/doc/_img/how-to-compile.png"></a></td>
+        <td align="center"><a href=tuning.md><img src="/doc/_img/fine-tuning.png"></a></td>
+        <td align="center"><a href=troubleshooting.md><img src="/doc/_img/troubleshooting.png"></a></td>
+        <td align="center"><a href=FAQ.md><img src="/doc/_img/faq.png"></a></td>
+    </tr>
+</table>

doc/compile/compile.md

@@ -1,4 +1,4 @@
-# Compile xmr-stak
+# Compile Xmr-Stak-RX
 
 ## Content Overview
 * [Build System](#build-system)
@@ -17,7 +17,7 @@ The build system is CMake, if you are not familiar with CMake you can learn more
 
 By default the miner will be build with all dependencies. Each optional dependency can be disabled (this will reduce the miner features).
 
-There are two easy ways to set variables for `cmake` to configure *xmr-stak*
+There are two easy ways to set variables for `cmake` to configure *xmr-stak-rx*
 - use the ncurses GUI
   - `ccmake ..`
   - edit your options
@@ -35,8 +35,8 @@ After the configuration you need to compile the miner, follow the guide for your
 
 ## Generic Build Options
 - `CMAKE_INSTALL_PREFIX` install miner to the home folder
-  - `cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/xmr-stak`
-  - you can find the binary and the `config.txt` file after `make install` in `$HOME/xmr-stak/bin`
+  - `cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/xmr-stak-rx`
+  - you can find the binary and the `config.txt` file after `make install` in `$HOME/xmr-stak-rx/bin`
 - `CMAKE_LINK_STATIC` link libgcc and libstdc++ libraries static (default OFF)
   - disable with `cmake .. -DCMAKE_LINK_STATIC=ON`
   - if you use static compile to run the miner on another system set `-DXMR-STAK_COMPILE=generic`
@@ -124,5 +124,5 @@ on Windows Driver Release Notes
 nVidia always puts the runtime-included CUDA version in the release notes PDF for whatever driver, doesn't hurt to
 double check your specific one.
 
-For better navigation of CUDA version matching, xmr-stak will display both version numbers during CUDA detection phases
+For better navigation of CUDA version matching, xmr-stak-rx will display both version numbers during CUDA detection phases
 such as `[9.2/10.0]` which is the compiled (SDK) version and the current (driver) runtime version.

doc/compile/compile_FreeBSD.md

@@ -1,4 +1,4 @@
-# Compile **xmr-stak** for FreeBSD
+# Compile **Xmr-Stak-RX** for FreeBSD
 
 ## Install Dependencies
 
@@ -10,10 +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.git
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     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.
+Now you have the binary located at "bin/" and the needed shared libraries.

doc/compile/compile_Linux.md

@@ -24,23 +24,23 @@ ROCm is not supporting old GPUs please check if your GPU is supported https://ro
 ```
     # Ubuntu / Debian
     sudo apt install libmicrohttpd-dev libssl-dev cmake build-essential libhwloc-dev
-    git clone https://github.com/fireice-uk/xmr-stak.git
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     mkdir xmr-stak/build
     cd xmr-stak/build
     cmake ..
     make install
 
     # Arch
     sudo pacman -S --needed base-devel hwloc openssl cmake libmicrohttpd
-    git clone https://github.com/fireice-uk/xmr-stak.git
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     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
-    git clone https://github.com/fireice-uk/xmr-stak.git
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     mkdir xmr-stak/build
     cd xmr-stak/build
     cmake ..
@@ -50,7 +50,7 @@ ROCm is not supporting old GPUs please check if your GPU is supported https://ro
     sudo yum install centos-release-scl epel-release
     sudo yum install cmake3 devtoolset-4-gcc* hwloc-devel libmicrohttpd-devel openssl-devel make
     scl enable devtoolset-4 bash
-    git clone https://github.com/fireice-uk/xmr-stak.git
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     mkdir xmr-stak/build
     cd xmr-stak/build
     cmake3 ..
@@ -65,7 +65,7 @@ ROCm is not supporting old GPUs please check if your GPU is supported https://ro
     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
+    git clone https://github.com/fireice-uk/xmr-stak.git -b xmr-stak-rx
     mkdir xmr-stak/build
     cd xmr-stak/build
     cmake ..
@@ -90,7 +90,7 @@ ROCm is not supporting old GPUs please check if your GPU is supported https://ro
     make
     sudo make install
     cd ..
-    git clone http://github.com/fireice-uk/xmr-stak
+    git clone http://github.com/fireice-uk/xmr-stak -b xmr-stak-rx
     cd xmr-stak
     mkdir build
     cd build
@@ -116,7 +116,5 @@ cmake -DCUDA_HOST_COMPILER=/usr/bin/gcc-5 ..
 ```
     cmake -DCMAKE_LINK_STATIC=ON -DXMR-STAK_COMPILE=generic .
     make install
-    cd bin\Release
-    copy C:\xmr-stak-dep\openssl\bin\* .
 ```
 Note - cmake caches variables, so if you want to do a dynamic build later you need to specify '-DCMAKE_LINK_STATIC=OFF'