Skip to content

Commit d268910

Browse files
committed
readme: fix formatting.
1 parent 8f21b7a commit d268910

1 file changed

Lines changed: 35 additions & 37 deletions

File tree

README.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,16 @@ dcrpool is a stratum decred mining pool. It currently supports:
99
* Antminer DR5 (default port: 5554)
1010
* Whatsminer D1 (default port: 5555)
1111

12-
The pool can be configured to mine in solo pool mode or as a publicly available
13-
mining pool. Solo pool mode represents a private mining pool operation where
14-
all connected miners to the pool are owned by the pool administrator.
15-
For this reason, mining rewards are left to accumulate at the specified
16-
address for the mining node. There isn't a need for payment processing in solo
17-
pool mining mode, it is disabled as a result.
18-
19-
In solo pool mining mode, miners only need to identify themselves when
20-
connecting to the pool. The miner's username, specifically the username
21-
sent in a `mining.authorize` message should be a unique name identifying
22-
the client.
12+
The pool can be configured to mine in solo pool mode or as a publicly available
13+
mining pool. Solo pool mode represents a private mining pool operation where
14+
all connected miners to the pool are owned by the pool administrator. For this
15+
reason, mining rewards are left to accumulate at the specified address for the
16+
mining node. There isn't a need for payment processing in solo pool mining mode,
17+
it is disabled as a result.
18+
19+
In solo pool mining mode, miners only need to identify themselves when
20+
connecting to the pool. The miner's username, specifically the username sent
21+
in a `mining.authorize` message should be a unique name identifying the client.
2322

2423
Here is a sample config for solo mining:
2524

@@ -37,25 +36,25 @@ guidir=GUI_DIR
3736

3837
Refer to config descriptions for more detail on the options.
3938

40-
The pool supports Pay Per Share (`PPS`) and Pay Per Last N Shares (`PPLNS`)
39+
The pool supports Pay Per Share (`PPS`) and Pay Per Last N Shares (`PPLNS`)
4140
payment schemes when configured for pool mining.
4241

43-
With pool mining, mining clients connect to the pool, contribute work towards
44-
solving a block and claim shares for participation. When a block is found by
45-
the pool, portions of the mining reward due participating accounts are
46-
calculated based on claimed shares and the payment scheme used. The pool pays
42+
With pool mining, mining clients connect to the pool, contribute work towards
43+
solving a block and claim shares for participation. When a block is found by
44+
the pool, portions of the mining reward due participating accounts are
45+
calculated based on claimed shares and the payment scheme used. The pool pays
4746
out the mining reward portions due each participating account when it matures.
4847

49-
In addition to identifying itself to the pool, each connecting miner has to
50-
specify the address its portion of the mining reward should be sent to
51-
when a block is found. For this reason, the mining client's username is a
52-
combination of the address mining rewards are paid to and its name,
53-
formatted as: `address.name`. This username format for pool mining is
54-
required. The pool uses the address provided in the username to create
55-
an account, all other connected miners with the same address set will
56-
contribute work to that account.
48+
In addition to identifying itself to the pool, each connecting miner has to
49+
specify the address its portion of the mining reward should be sent to when a
50+
block is found. For this reason, the mining client's username is a combination
51+
of the address mining rewards are paid to and its name, formatted as:
52+
`address.name`. This username format for pool mining is required. The pool uses
53+
the address provided in the username to create an account, all other connected
54+
miners with the same address set will contribute work to that account.
5755

5856
Here is a sample config for pool mining:
57+
5958
```
6059
rpcuser=RPC_USER
6160
rpcpass=RPC_PASS
@@ -77,18 +76,17 @@ guidir=GUI_DIR
7776

7877
Refer to config descriptions for more detail on the options.
7978

80-
The user interface of the pool provides public access to statistics and pool
81-
account data. Users of the pool can access all payments, mined blocks by the
82-
account and also work contributed by clients of the account via the interface.
83-
The interface is only accessible via HTTPS and by default uses a self-signed
84-
certificate, served on port `:8080`. In production, particularly for pool
85-
mining, a certificate from an authority (`CA`) like [letsencrypt](https://letsencrypt.org/) is recommended.
86-
The user interface also provides pool administrators database backup
87-
functionality when needed.
79+
The user interface of the pool provides public access to statistics and pool
80+
account data. Users of the pool can access all payments, mined blocks by the
81+
account and also work contributed by clients of the account via the interface.
82+
The interface is only accessible via HTTPS and by default uses a self-signed
83+
certificate, served on port `:8080`. In production, particularly for pool
84+
mining, a certificate from an authority (`CA`) like
85+
[letsencrypt](https://letsencrypt.org/) is recommended. The user interface also
86+
provides pool administrators database backup functionality when needed.
8887

8988
To deploy the user interface, copy `dcrpool/gui/assets` folder to a reachable
90-
location and update the gui directory (`--guidir`) of the
91-
configuration.
89+
location and update the gui directory (`--guidir`) of the configuration.
9290

9391
To install and run dcrpool:
9492

@@ -99,7 +97,7 @@ go install
9997
dcrpool --configfile=path/to/config.conf
10098
```
10199

102-
The project has a tmux mining harness and a cpu miner for testing.
100+
The project has a tmux mining harness and a cpu miner for testing.
103101
Refer to `harness.sh` for configuration details.
104102

105103
To install and run the cpu miner:
@@ -117,5 +115,5 @@ cd dcrpool
117115
./harness.sh
118116
```
119117

120-
Thanks to davecgh, SweeperAA, dhill, jhartbarger, NickH and jholdstock for their
121-
contributions.
118+
Thanks to davecgh, SweeperAA, dhill, jhartbarger, NickH and jholdstock for
119+
their contributions.

0 commit comments

Comments
 (0)