************************************

* *
* BzMiner v7.2 Quick Start Guide *
* *
************************************

### Command Line ###

use the following command to have all GPUs mine on the same pool and wallet:

`bzminer -a ethash -r rig_name -p pool_address -w wallet_address`

change ethash to the algorithm you want to mine. Algorithms are:

ethash (Ethereum, 0.5% dev fee)
etchash (Ethereum Classic, 0.5% dev fee)
kawpow (Ravencoin, 0.5% dev fee)
olhash (Overline, 1% dev fee)
alph (Alephium, 1% dev fee) (May require 4 addresses)

### Config File ###

Update the following properties in the config file under the "pool_configs" option:

algorithm: the algorithm you are mining

wallet: wallet to mine to
url: pool url
username: rig name (worker name)

Then run bzminer or through the command line:

`bzminer`

Optionally you can specify the config file to load:

`bzminer -c config.txt`

### Advanced Config Options ###

In the config file, set "advanced_config" to true for more configuration options

Set "advanced_display_config" to true to show configuration options for the miner

output

### Graphical User Interface ###

BzMiner will save out a file called "index.html" which will connect to your
localhost in a web browser with the port set from the config file. This is where
you will find the BzMiner GUI, which will allow you to remotely monitor your rig,
as well as view other rigs on the network and adjust settings on the miners
remotely.

To show the other devices on the network, BzMiner broadcasts a udp message over the
local area network, and waits for responses from other instances of bzminer. This
can be disabled in BzMiner through the config flag "disable_udp". If this is
disabled, that rig will not respond to this message, and will not show up in the
GUI's rigs column for other BzMiner instances.

### Hive OS Note ###

Running BzMiner manually on Hive OS (without running through the Hive OS
flightsheet) requires the following command to be ran before running BzMiner:

export LD_LIBRARY_PATH=/hive/lib

### Disable specific GPUs ###

GPU's can be disabled either through the command line or through config.txt

The command line argument is "--disable" and expects a space separated list of gpu
unique ids, or indexes

eg.

"bzminer --disable 1:0 3:0"

or

"bzminer --disable 0 3 5"

Optionally they can be disabled directly from the config.txt file, under the gpu in
the config.txt file, set "auto_start" to false

### Watchdog ###

By default, the BzMiner watchdog is enabled, which will restart BzMiner if it ever
gets stuck. Optionally in the configuration file, you can set whether BzMiner
reboots the rig when hung gpus are detected, as well as automatically call a script
which can be specified in the config file under the option "crash_script". When
crash_script is called (if specified), the last BzMiner log (to both the standard
output and the log file if specified) will be in the format of:

Hung GPU detected! (gpu_bus_id:gpu_device_id)

where gpu_bus_id and gpu_device_id are the identifiers for which GPU was detected
as hung (not responding)