Merge pull request #2579 from psychocrypt/topic-updateReadme

update README

README.md

@@ -1,115 +1,10 @@
-###### fireice-uk's and psychocrypt's
-# XMR-Stak: Cryptonight All-in-One Mining Software
-
-XMR-Stak is a universal open source stratum pool miner. This miner supports x86-64 CPUs, AMD and NVIDIA GPUs and can be used various crypto currencies: Ryo, Monero, Turtlecoin, Graft, Bittube, and many more Cryptonight coins.
-
-
-
-## 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](#default-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 15 cryptonight-variant mining algorithms + Cryptonight-GPU.
-- 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:
-
-
-- [BitTube](https://coin.bit.tube/)
-- [Conceal](https://conceal.network)
-- [Graft](https://www.graft.network)
-- [Haven](https://havenprotocol.com)
-- [Lethean](https://lethean.io)
-- [Masari](https://getmasari.org)
-- [Monero](https://getmonero.org)
-- [Plenteum](https://www.plenteum.com/)
-- [QRL](https://theqrl.org)
-- **[Ryo](https://ryo-currency.com) - Upcoming xmr-stak-gui is sponsored by Ryo Currency**
-- [Torque](https://torque.cash/)
-- [Zelerius](https://zelerius.org/)
-
-**[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:
-- 256Kib scratchpad memory
-    - cryptonight_turtle
-
-
-- 1MiB scratchpad memory
-    - cryptonight_lite
-    - cryptonight_lite_v7
-    - cryptonight_lite_v7_xor (algorithm used by ipbc)
-
-
-- 2MiB scratchpad memory
-    - cryptonight
-    - cryptonight_gpu (for Ryo's 14th of Feb fork)
-    - cryptonight_r
-    - cryptonight_masari (used in 2018)
-    - cryptonight_conceal
-    - cryptonight_v7
-    - cryptonight_v7_stellite
-    - cryptonight_v8
-    - cryptonight_v8_double (used by X-CASH)
-    - cryptonight_v8_half (used by masari and torque)
-    - cryptonight_v8_reversewaltz (used by graft)
-    - cryptonight_v8_zelerius
-
-
-- 4MiB scratchpad memory
-    - cryptonight_haven
-    - cryptonight_heavy
-
-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).
-
-## Default Developer Donation
-
-By default, the miner will donate 2% of the hashpower (2 minutes in 100 minutes) to my pool. If you want to change that, edit [donate-level.hpp](xmrstak/donate-level.hpp) before you build the binaries.
-
-If you want to donate directly to support further development, here is my wallet
-
-fireice-uk:
-```
-4581HhZkQHgZrZjKeCfCJxZff9E3xCgHGF25zABZz7oR71TnbbgiS7sK9jveE6Dx6uMs2LwszDuvQJgRZQotdpHt1fTdDhk
-```
-
-psychocrypt:
-```
-45tcqnJMgd3VqeTznNotiNj4G9PQoK67TGRiHyj6EYSZ31NUbAfs9XdiU5squmZb717iHJLxZv3KfEw8jCYGL5wa19yrVCn
-```
+<a href="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=https://github.com/fireice-uk/xmr-stak/tree/xmr-stak-rx/doc/README.md><img src="doc/_img/rx.png"></a></td>
+    </tr>
+</table>

doc/README.md

@@ -0,0 +1,132 @@
+
+<table>
+    <tr>
+        <td align="center"><a href=https://github.com/fireice-uk/xmr-stak/tree/tree/xmr-stak-rx/doc/README.md><img src="_img/xmr-stak-rx-btn-inactive.png"></a></td>
+        <td align="center"><a href=#><img src="_img/xmr-stak-btn-active.png"></a></td>
+        <td align="center"><a href=https://ragerx.lol><img src="_img/ragerx-btn.png"></a></td>
+    </tr>
+</table>
+
+<table>
+    <tr>
+        <td align="center"><a href=#features-overview><img src="_img/menu-features-green.png"></a></td>
+        <td align="center"><a href=#supported-coins-and-algorithms><img src="_img/menu-supported-coins-green.png"></a></td>
+        <td align="center"><a href=#get-miner><img src="_img/menu-get-miner-green.png"></a></td>
+        <td align="center"><a href=#additional-guides-and-feedback><img src="_img/menu-support-green.png"></a></td>
+        <td align="center"><a href=#default-developer-donation><img src="_img/menu-donations-green.png"></a></td>
+    </tr>
+</table>
+
+ <table>
+     <tr>
+         <td align="center"><a href=usage.md><img src="_img/usage-green.png"></a></td>
+         <td align="center"><a href=compile/compile.md><img src="_img/how-to-compile-green.png"></a></td>
+         <td align="center"><a href=tuning.md><img src="_img/fine-tuning-green.png"></a></td>
+         <td align="center"><a href=troubleshooting.md><img src="_img/troubleshooting-green.png"></a></td>
+         <td align="center"><a href=FAQ.md><img src="_img/faq-green.png"></a></td>
+     </tr>
+ </table>
+
+## Introduction
+XMR-Stak is a universal open source stratum pool miner. This miner supports CPUs, AMD and NVIDIA GPUs and can be used for mining various crypto currencies: Ryo, Graft, Bittube, Conceal, Haven and many more Cryptonight coins.
+
+## Features overview
+[<img src="_img/features-xmr-stak.png">](#)
+
+## Supported coins and algorithms
+Xmr-Stak supports various variants of Cryptonight 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 Cryptonight algorithm for mining):
+
+|  |  |  |
+| ---  | ---  | --- |
+| [BitTube](https://coin.bit.tube/) | [Plenteum](https://www.plenteum.com/) |  |
+| [Conceal](https://conceal.network) | [QRL](https://theqrl.org) |  |
+| [Graft](https://www.graft.network) | [Ryo](https://ryo-currency.com)  | **Atom Wallet Solo mining mode is sponsored by [RYO](https://ryo-currency.com/)** |
+| [Haven](https://havenprotocol.com) | [X-CASH](https://x-network.io/) |  |
+| [Lethean](https://lethean.io) | [Zelerius](https://zelerius.org/) |  |
+| [Masari](https://getmasari.org) |  |  |
+
+
+**[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:
+
+| 256 KiB scratchpad memory | 1 MiB scratchpad memory | 2 MiB scratchpad memory | 4 MiB scratchpad memory |
+| --- | --- | --- | --- | 
+| cryptonight_turtle  | cryptonight_lite  | cryptonight  | cryptonight_bittube2  | 
+| ---  | cryptonight_lite_v7  | cryptonight_gpu  | cryptonight_haven  | 
+| ---  | ---  | cryptonight_conceal  | cryptonight_heavy  | 
+| ---  | ---  | cryptonight_r  | ---  | 
+| ---  | ---  | cryptonight_masari (used in 2018)  | ---  | 
+| ---  | ---  | cryptonight_v8_reversewaltz  | ---  | 
+| ---  | ---  | cryptonight_v7  | ---  | 
+| ---  | ---  | cryptonight_v8  | ---  | 
+| ---  | ---  | cryptonight_v8_half (used by masari)  | ---  | 
+| ---  | ---  | cryptonight_v8_double (used by X-CASH)  | ---  | 
+| ---  | ---  | cryptonight_v8_zelerius  | ---  | 
+
+Please note, this list is not complete and is not an endorsement.
+
+
+## Get Miner
+Please note that code is developed on the [dev branch](https://github.com/fireice-uk/xmr-stak/commits/dev), 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.git`  
+
+Also you can find the latest releases and precompiled binaries on GitHub under [releases](https://github.com/fireice-uk/xmr-stak/releases/latest) section.
+
+If you want to compile the miner from source files, navigate to ["how to compile"](compile/compile.md) section of docs or [xmr-stak forum](https://www.reddit.com/r/XmrStak/wiki/guides/startup) 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
+
+
+## Additional Guides and Feedback
+[<img src="_img/stak-yt-cover.jpg">](https://www.youtube.com/playlist?list=PLAhUkom29iGMFoN8pk91JA-oqvxlmJ5H8)
+###### Video by Crypto Sewer
+
+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).
+
+ <table>
+     <tr>
+         <td align="center"><a href=usage.md><img src="_img/usage-green.png"></a></td>
+         <td align="center"><a href=compile/compile.md><img src="_img/how-to-compile-green.png"></a></td>
+         <td align="center"><a href=tuning.md><img src="_img/fine-tuning-green.png"></a></td>
+         <td align="center"><a href=troubleshooting.md><img src="_img/troubleshooting-green.png"></a></td>
+         <td align="center"><a href=FAQ.md><img src="_img/faq-green.png"></a></td>
+     </tr>
+ </table>
+
+## Default Developer Donation
+By default, the miner will donate 2% of the hashpower (2 minutes in 100 minutes) to my pool. If you want to change that, edit [donate-level.hpp](xmrstak/donate-level.hpp) before you build the binaries.
+
+If you want to donate directly to support further development, here is my wallet
+
+fireice-uk:
+```
+4581HhZkQHgZrZjKeCfCJxZff9E3xCgHGF25zABZz7oR71TnbbgiS7sK9jveE6Dx6uMs2LwszDuvQJgRZQotdpHt1fTdDhk
+```
+
+psychocrypt:
+```
+45tcqnJMgd3VqeTznNotiNj4G9PQoK67TGRiHyj6EYSZ31NUbAfs9XdiU5squmZb717iHJLxZv3KfEw8jCYGL5wa19yrVCn
+```