Skip to content

Commit 5b31951

Browse files
committed
Finalize the Makefile
Signed-off-by: Pttn <28868425+Pttn@users.noreply.github.com>
1 parent 64a36d7 commit 5b31951

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ rieMiner is a Riecoin miner supporting both solo and pooled mining. It was origi
44

55
Solo mining is done using the GetBlockTemplate protocol, while pooled mining is via the Stratum protocol. A benchmark mode is also proposed to compare more easily the performance between different computers.
66

7-
Direct link to the latest official [Windows x64 standalone executable](https://ric.pttn.me/file.php?d=rieMinerWin64).
7+
Direct links to the latest official [Windows x64](https://ric.pttn.me/file.php?d=rieMinerWin64) and [Win32](https://ric.pttn.me/file.php?d=rieMinerWin32) standalone executables. Binaries built on Debian 9 with almost complete static linking also available (these should run on fresh Debian and Ubuntu installations): [Deb64](https://ric.pttn.me/file.php?d=rieMinerDeb64) and [Deb32](https://ric.pttn.me/file.php?d=rieMinerDeb32). Also note that 32 bits builds are much slower.
88

9-
This README also serves as manual for rieMiner. I hope that this program will be useful for you! Happy mining!
9+
This README serves as manual for rieMiner, and you can also find a [PDF version](https://ric.pttn.me/file.php?d=rieMinerManual) (without build instructions). I hope that this program will be useful for you!
1010

11-
The Riecoin community thanks you for your participation, you will be a contributor to the robustness of the Riecoin network.
11+
The Riecoin community thanks you for your participation, you will be a contributor to the robustness of the Riecoin network. Happy mining!
1212

1313
![rieMiner just found a block](https://ric.pttn.me/file.php?d=rieMiner)
1414

@@ -34,41 +34,42 @@ Recommended:
3434

3535
You can compile this C++ program with g++, as, m4 and make, install them if needed. Then, get if needed the following dependencies:
3636

37-
* Jansson
38-
* cURL
39-
* libSSL
40-
* GMP
37+
* [Jansson](http://www.digip.org/jansson/)
38+
* [cURL](https://curl.haxx.se/)
39+
* [libSSL](https://www.openssl.org/)
40+
* [GMP](https://gmplib.org/)
4141

4242
On a recent enough Debian or Ubuntu, you can easily install these by doing as root:
4343

4444
```bash
4545
apt install g++ make m4 git libjansson-dev libcurl4-openssl-dev libssl-dev libgmp-dev
4646
```
4747

48-
Then, just download the source files, go/cd to the directory, and do a simple make:
48+
Then, just download the source files, go/`cd` to the directory, and do a simple make:
4949

5050
```bash
5151
git clone https://github.com/Pttn/rieMiner.git
5252
cd rieMiner
5353
make
5454
```
5555

56-
For other Linux, executing equivalent commands (using pacman instead of apt,...) should work.
56+
For other Linux, executing equivalent commands (using `pacman` instead of `apt`,...) should work.
5757

58-
If you get a warning after the compilation that there may be a conflict between libcrypto.so files, install libssl1.0-dev instead of libssl-dev.
58+
If you get a warning after the compilation that there may be a conflict between libcrypto.so files, install `libssl1.0-dev` instead of `libssl-dev`.
5959

6060
### In Windows x64
6161

6262
You can compile rieMiner in Windows, and here is one way to do this. First, install [MSYS2](http://www.msys2.org/) (follow the instructions on the website), then enter in the MSYS **MinGW-w64** console, and install the tools and dependencies:
6363

6464
```bash
65-
pacman -S make
66-
pacman -S git
65+
pacman -S make git
6766
pacman -S mingw64/mingw-w64-x86_64-gcc
6867
pacman -S mingw64/mingw-w64-x86_64-curl
6968
```
7069

71-
Clone rieMiner with git like for Linux, go to its directory with cd, and compile with make.
70+
Note that you must install the `mingw64/mingw-w64-x86_64-...` packages and not just `gcc` or `curl`.
71+
72+
Clone rieMiner with `git` like for Linux, go to its directory with `cd`, and compile with `make`.
7273

7374
#### Static building
7475

@@ -89,7 +90,7 @@ Once done:
8990
* In the downloaded libcurl directory, go to the include directory and copy the "curl" folder to the "incs" folder;
9091
* Do the same with the file "libcurl.a" from the libs/.lib folder to the rieMiner's "libs" folder.
9192

92-
Now, you should be able to compile rieMiner with "make static" and produce a standalone executable.
93+
Now, you should be able to compile rieMiner with `make static` and produce a standalone executable.
9394

9495
## Run and configure this program
9596

@@ -144,6 +145,17 @@ TupleLengthMin = 4
144145
# For solo mining, add consensus rules in the GetBlockTemplate RPC call, each separated by a comma.
145146
# Useful for softforks, for example, to mine SegWit transactions, you would need the following line. Default: no rule
146147
# Rules = segwit
148+
149+
# Other options
150+
# BenchmarkDifficulty = 1600
151+
# BenchmarkTimeLimit = 0
152+
# Benchmark2tupleCountLimit = 100000
153+
# SieveBits = 25
154+
# SieveWorkers = 0
155+
# ConstellationType = 0, 4, 2, 4, 2, 4
156+
# PrimorialNumber = 40
157+
# PrimorialOffsets = 4209995887, 4209999247, 4210002607, 4210005967, 7452755407, 7452758767, 7452762127, 7452765487, 8145217177, 8145220537, 8145223897, 8145227257
158+
# Debug = 0
147159
```
148160

149161
It is also possible to use custom configuration file paths, examples:
@@ -193,7 +205,7 @@ Also see the constellationsGen tool in my rieTools repository (https://github.co
193205

194206
### Memory problems
195207

196-
If you have memory errors, try to lower the PrimeTableLimit value in the configuration file.
208+
If you have memory errors (Unable to allocate... or Bad Allocs), try to lower the PrimeTableLimit value in the configuration file.
197209

198210
## Statistics
199211

0 commit comments

Comments
 (0)