Skip to content

Commit 98db571

Browse files
HugoXOX3HugoXOX3
authored
Update README.md
1 parent b300742 commit 98db571

File tree

1 file changed

+139
-150
lines changed

1 file changed

+139
-150
lines changed

‎README.md‎

Lines changed: 139 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -1,213 +1,202 @@
11
# Bitcoin Solo Miner
22

33
---
4-
Updatest Version
5-
---
4+
5+
## Latest Version
6+
67
[Version Beta v2.0.0](https://github.com/HugoXOX3/PythonBitcoinMiner/releases/tag/Minerv2.0.0)
78

8-
It is still a debug version which fix all the bug in version v1.x.x.
9+
This is still a debug version which fixes all the bugs in version v1.x.x.
910

10-
However,it may have some new bugs or errors.
11+
However, it may have some new bugs or errors.
1112

12-
Please report it at [Issues](https://github.com/HugoXOX3/PythonBitcoinMiner/issues) to improve and fix the program.
13+
Please report any issues at [Issues](https://github.com/HugoXOX3/PythonBitcoinMiner/issues) to help improve and fix the program.
1314

14-
# Bitcoin Solo Miner Version 1.x.x and Document
15+
## Bitcoin Solo Miner Version 1.x.x and Documentation
1516

16-
---
17-
Details
1817
---
1918

20-
This SoloMiner doesnt request any developing fee and it connect to blockchain api the get details like TxIndex to alternate RPC server.As a result,we dont need to run a bitcoin core in local and we can sent our accept share into your mining pool like ckpool
19+
## Details
2120

21+
This SoloMiner does not request any development fee and connects to the blockchain API to get details like TxIndex to alternate RPC server. As a result, we do not need to run a Bitcoin core locally, and we can send our accepted shares to your mining pool like ckpool.
2222

23-
---
24-
Error Occur?
2523
---
2624

27-
[Go to here](https://github.com/HugoXOX3/PythonMiner/blob/main/FixBug.md) to find out the reason and fix it.
25+
## Error Occurred?
2826

27+
[Go here](https://github.com/HugoXOX3/PythonMiner/blob/main/FixBug.md) to find out the reason and how to fix it.
2928

3029
---
31-
Ask for help?
32-
---
33-
[Go to here](https://github.com/HugoXOX3/PythonMiner/discussions)
3430

35-
---
36-
Requirement
31+
## Need Help?
32+
33+
[Go here](https://github.com/HugoXOX3/PythonMiner/discussions)
34+
3735
---
3836

39-
Python3.x
40-
[Go Download](https://www.python.org/)
37+
## Requirements
4138

42-
Create your own Bitcoin Address:[Bitcoin Core](https://bitcoin.org/en/bitcoin-core/)/[Electrum](https://electrum.org/?ref=hackernoon.com) etc(Just prepare address that you want to)
39+
- Python 3.x
40+
- [Download Python](https://www.python.org/)
41+
- Create your own Bitcoin Address:
42+
- [Bitcoin Core](https://bitcoin.org/en/bitcoin-core/)
43+
- [Electrum](https://electrum.org/?ref=hackernoon.com)
44+
- (Just prepare an address that you want to use)
4345

44-
---
45-
Download the relase
4646
---
4747

48-
First,Download the latest miner from [release](https://github.com/HugoXOX3/BTCSoloMiner/releases)
48+
## Download the Release
49+
50+
First, download the latest miner from [releases](https://github.com/HugoXOX3/BTCSoloMiner/releases)
4951

5052
# Mining BTC with
5153

52-
[Windows/Linux/Mac](https://github.com/HugoXOX3/PythonMiner#for-windows-linux-mac)
54+
- [Windows/Linux/Mac](https://github.com/HugoXOX3/PythonMiner#for-windows-linux-mac)
55+
- [Hide Console Version](https://github.com/HugoXOX3/PythonMiner#for-hide-console-version)
56+
- [Android & IOS](https://github.com/HugoXOX3/PythonMiner#androidios)
57+
- [UNIX](https://github.com/HugoXOX3/PythonMiner/blob/main/UNIX.md)
58+
59+
# For Windows/Linux/Mac
5360

54-
[Hide Console Version](https://github.com/HugoXOX3/PythonMiner#for-hide-console-version)
61+
## How to Use
5562

56-
[Android & IOS](https://github.com/HugoXOX3/PythonMiner#androidios)
63+
1. Change the settings:
64+
```python
65+
# Setting
66+
# Mining Address **Change Me**
67+
address = 'xxx'
68+
# Mining Pool
69+
pool = "solo.ckpool.org"
70+
port = 3333
71+
```
5772

58-
[UNIX](https://github.com/HugoXOX3/PythonMiner/blob/main/UNIX.md)
73+
2. Run the program:
74+
```sh
75+
python3 SoloMiner.py
76+
```
5977

78+
![Windows example](https://github.com/HugoXOX3/PythonMiner/blob/main/Image/Windows%20Version.png)
6079

61-
# For Windows Linux Mac
80+
# For Hide Console Version
6281

63-
# How to use
82+
1. Change the settings:
83+
```python
84+
# Setting
85+
# Mining Address **Change Me**
86+
address = 'xxx'
87+
# Mining Pool
88+
pool = "solo.ckpool.org"
89+
port = 3333
90+
```
6491

65-
1. Change the setting
66-
```
67-
#Setting
68-
# Mining Address **Change Me**
69-
address = 'xxx'
70-
# Mining Pool
71-
pool = "solo.ckpool.org"
72-
port = 3333
73-
```
92+
2. Run the program:
7493

75-
2. run the programme like:
76-
```
77-
python3 SoloMiner.py
78-
```
94+
Double-click `main.pyw` to start the program or type in terminal/cmd:
95+
```sh
96+
main.pyw
97+
```
98+
You can confirm it is running in Task Manager (look for python.exe).
7999

100+
Windows users can also drag this file into `shell:startup` so that mining will start automatically when the PC is on.
80101

81-
![Windows example](https://github.com/HugoXOX3/PythonMiner/blob/main/Image/Windows%20Version.png)
102+
# Android & iOS
82103

104+
The way to run this miner on Android and iOS is to run a Linux Terminal on them, like Termux & iSH.
83105

84-
# For Hide Console Version
106+
---
85107

86-
1. Change the setting
87-
```
88-
#Setting
89-
# Mining Address **Change Me**
90-
address = 'xxx'
91-
# Mining Pool
92-
pool = "solo.ckpool.org"
93-
port = 3333
94-
```
108+
## Android
95109

96-
2. Run programme
110+
1. [Go to the Play Store and download Termux](https://play.google.com/store/apps/details?id=com.termux)
97111

98-
Double click 'main.pyw' to start programme or type in terminal/cmd like :
99-
```
100-
main.pyw
101-
```
102-
You can confirm it run in Task Manager(Find the usage of python.exe).
112+
2. Open Termux and type:
113+
```sh
114+
pkg update
115+
pkg upgrade
116+
pkg install python3
117+
pkg install git
118+
pip3 install requests colorama
119+
git clone https://github.com/HugoXOX3/PythonMiner.git
120+
cd PythonMiner
121+
```
103122

104-
BTW,Windows User can also drag this file into'shell:startup' so that mining will start automaticlly when PC is on
123+
3. Change the wallet in this program to yours using nano or vim:
124+
```python
125+
# Python Bitcoin Solo Miner
126+
import requests
127+
import socket
128+
.
129+
.
130+
.
105131

132+
## Mining Address **Change Me**
133+
address = 'Change this to your wallet'
134+
pool = 'stratum.solomining.io'
135+
port = 7777
136+
```
106137

107-
# Android&IOS
138+
4. Run the program:
139+
```sh
140+
python3 SoloMiner.py
141+
```
108142

109-
The ways I find out to run this miner on Android and IOS is to run a Linux Terminal on them like Termux & Ish
143+
5. Input your Bitcoin address and enjoy mining.
110144

111145
---
112-
Android
113-
---
114-
[First,Go to play store and downlaod Termux](https://play.google.com/store/apps/details?id=com.termux)
115-
116-
Next,open Termux and type:
117-
118-
```
119-
pkg update
120-
pkg upgrade
121-
pkg install python3
122-
pkg install git
123-
pip3 install requests colorama
124-
git clone https://github.com/HugoXOX3/PythonMiner.git
125-
cd PythonMiner
126-
```
127-
128-
Then,you need to change the wallet in this programme to yours by using nano or vim
129-
```
130-
# Python Bitcoin Solo Miner
131-
import requests
132-
import socket
133-
.
134-
.
135-
.
136-
137-
## Mining Address **Change Me**
138-
address = 'Change this to your wallet'
139-
pool = 'stratum.solomining.io'
140-
port = 7777
141-
```
142-
143-
144-
After that,You can run the programe like:
145-
```
146-
python3 SoloMiner.py
147-
```
148-
149-
Finally,Just input your Bitcoin address an enjoy mining
150146

151-
---
152-
IOS
153-
---
154-
First,download app [ish](https://apps.apple.com/cn/app/ish-shell/id1436902243) in appstore and launch it
155-
156-
Next,type to install stuff
157-
```
158-
apk add python3
159-
apk add git
160-
git clone https://github.com/HugoXOX3/PythonMiner.git
161-
cd PythonMiner
162-
```
163-
164-
Also you need to change the wallet in this programme to yours by using nano or vim
165-
```
166-
# Python Bitcoin Solo Miner
167-
import requests
168-
import socket
169-
.
170-
.
171-
.
172-
173-
## Mining Address **Change Me**
174-
address = 'Change this to your wallet'
175-
pool = 'stratum.solomining.io'
176-
port = 7777
177-
```
178-
179-
After that type this to run miner
180-
```
181-
python3 SoloMiner.py
182-
```
183-
184-
Finally,type in your Bitcoin Address and Enjoy mining
185-
186-
Like:
147+
## iOS
187148

188-
![example](https://github.com/HugoXOX3/PythonMiner/blob/main/Image/IOS.jpeg)
149+
1. Download the app [iSH](https://apps.apple.com/cn/app/ish-shell/id1436902243) from the App Store and launch it.
189150

190-
---
191-
Warning
192-
---
151+
2. Type to install stuff:
152+
```sh
153+
apk add python3
154+
apk add git
155+
git clone https://github.com/HugoXOX3/PythonMiner.git
156+
cd PythonMiner
157+
```
193158

194-
⚠️ Mining Bitcoin on a mobile device with a bad cooling may damage your device
159+
3. Change the wallet in this program to yours using nano or vim:
160+
```python
161+
# Python Bitcoin Solo Miner
162+
import requests
163+
import socket
164+
.
165+
.
166+
.
195167

196-
---
197-
Credits
198-
---
168+
## Mining Address **Change Me**
169+
address = 'Change this to your wallet'
170+
pool = 'stratum.solomining.io'
171+
port = 7777
172+
```
173+
174+
4. Run the miner:
175+
```sh
176+
python3 SoloMiner.py
177+
```
199178

200-
[BitcoinSoloPy](https://github.com/DaCryptoRaccoon/BitcoinSoloPy)
179+
5. Input your Bitcoin address and enjoy mining.
201180

202-
[SoloMinerV2](https://github.com/Pymmdrza/SoloMinerV2)
181+
![example](https://github.com/HugoXOX3/PythonMiner/blob/main/Image/IOS.jpeg)
203182

204183
---
205-
Done
184+
185+
## Warning
186+
187+
⚠️ Mining Bitcoin on a mobile device with poor cooling may damage your device.
188+
206189
---
207190

208-
✅Mining with IOS(I already have some ideas to mine on it by using [ish](https://github.com/ish-app/ish)
191+
## Credits
209192

210-
✅Save Address Function
193+
- [BitcoinSoloPy](https://github.com/DaCryptoRaccoon/BitcoinSoloPy)
194+
- [SoloMinerV2](https://github.com/Pymmdrza/SoloMinerV2)
195+
196+
---
211197

212-
✅Customise Solo Mining pool(Bug Fix)
198+
## Done
213199

200+
- ✅ Mining with iOS (I already have some ideas to mine on it by using [iSH](https://github.com/ish-app/ish))
201+
- ✅ Save Address Function
202+
- ✅ Customize Solo Mining Pool (Bug Fix)

0 commit comments

Comments
 (0)