readme

Author: mining-visualizer

README.md

@@ -18,13 +18,25 @@ This is a fork of my MVis-ethminer program, which was a fork of Genoil's ethmine
 
 * Unzip the [download package](https://github.com/mining-visualizer/MVis-tokenminer/releases) anywhere you like.  
 * Open up `tokenminer.ini` using any text editor and set the following configuration items:
-* For POOL MINING, the main thing you need to specify in the .INI file is your ETH account address to which rewards will be paid out. Look for the line that starts with `MinerAcct=`.  You can also specify the pool mining address in the `[Node]` section, or you can do that on the command line (-N).  See below for all command line options.
-* For SOLO MINING:
+* For **Pool Mining**, you need to specify your mining pool and your ETH address. 
+
+```
+[Node]
+Host=http://your_mining_pool.com   
+RPCPort=8586
+
+[0xBitcoin]
+MinerAcct=0x1234512345123451234512345123451234512345
+```
+* All other settings in the `[0xBitcoin]` section can be left as is.
+* You can also specify the pool mining address on the command line (-N).  See below for all command line options.
+* If you mining pool supports the **stratum protocol**, change the `RPCPort=8586` line to `StratumPort=9192`.  Consult with your mining pool for the actual port #.
+* For **Solo Mining**:
     * Input an ETH account and associated private key. (Sorry about making you enter it in plain text format. Make sure it is a 'throw away' account with only the bare minimum amount of money.)
     * You can specify the address and port of your node in the `.ini` file, or on the command line.
     * You can enable gas price bidding.  (see comments in the file).  Note that enabling this feature does not guarantee that you will win every bid.  Network latency will sometimes result in failed transactions, even if you 'out-bid' the other transaction.
 * You can leave the .INI file in the executable folder,  or you can move it to `C:\Users\[USER]\AppData\Local\tokenminer` on Windows, or `$HOME/.config/tokenminer` on Linux.  If that folder path does not exist, you will need to create it manually. If for some reason that file exists at both locations, the one in the executable folder will take precedence. 
-* WINDOWS ONLY: download and install **both** the [VC 2013 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=40784) and the [VC 2015 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145)
+* **WINDOWS ONLY**: download and install both the [VC 2013 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=40784) and the [VC 2015 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145)
 * Double-click on the file `list-devices.bat`.  Examine the screen output and verify your GPU's are recognized.  Pay special attention to the PlatformID.  If it is anything other than 0, you will need to edit the `start-mining.bat` file and change the `--opencl-platform <n>` argument.
 * Start POOL MINING by double-clicking on `start-mining.bat`.
 * Start SOLO MINING with `tokenminer.exe -S -G`.  This assumes you've specified the node address in the .INI file.
@@ -92,6 +104,9 @@ Node configuration:
 ; Examples, POOL MINING:
 ;    Host=http://your_mining_pool.com   
 ;    RPCPort=8586
+;      or
+;    StratumPort=9192
+;
 ; Examples, SOLO MINING:
 ;    Host=127.0.0.1
 ;    Host=https://mainnet.infura.io/your_api_key