Skip to content

Commit 8c94d1c

Browse files
committed
Reformat README.md and add "is compiling" badges
1 parent dce36aa commit 8c94d1c

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed

README.md

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,49 @@
1-
# chia-blockchain
2-
Please check out the [wiki](https://github.com/Chia-Network/chia-blockchain/wiki) and [FAQ](https://github.com/Chia-Network/chia-blockchain/wiki/FAQ) for information on this project.
3-
4-
Python 3.7+ is required. Make sure your default python version is >=3.7 by typing `python3`.
1+
![Build Ubuntu and MacOS](https://github.com/Chia-Network/chia-blockchain/workflows/Build%20Ubuntu%20and%20MacOS/badge.svg) ![Build Windows Installer](https://github.com/Chia-Network/chia-blockchain/workflows/Build%20Windows%20Installer/badge.svg)
52

6-
If you are behind a NAT, it can be difficult for peers outside your subnet to reach you when they start up. You can enable
7-
[UPnP](https://www.homenethowto.com/ports-and-nat/upnp-automatic-port-forward/) on your router or add a
8-
NAT (for IPv4 but not IPv6) and firewall rules to allow TCP port 8444 access to your peer.
3+
# chia-blockchain
4+
Please check out the [wiki](https://github.com/Chia-Network/chia-blockchain/wiki)
5+
and [FAQ](https://github.com/Chia-Network/chia-blockchain/wiki/FAQ) for
6+
information on this project.
7+
8+
Python 3.7+ is required. Make sure your default python version is >=3.7
9+
by typing `python3`.
10+
11+
If you are behind a NAT, it can be difficult for peers outside your subnet to
12+
reach you when they start up. You can enable
13+
[UPnP](https://www.homenethowto.com/ports-and-nat/upnp-automatic-port-forward/)
14+
on your router or add a NAT (for IPv4 but not IPv6) and firewall rules to allow
15+
TCP port 8444 access to your peer.
916
These methods tend to be router make/model specific.
1017

11-
Most should only install harvesters, farmers, plotter, full nodes, and wallets. Building timelords and VDFs is for sophisticated users in most environments. Chia Network and additional volunteers are running sufficient time lords for testnet consensus.
18+
Most should only install harvesters, farmers, plotter, full nodes, and wallets.
19+
Building timelords and VDFs is for sophisticated users in most environments.
20+
Chia Network and additional volunteers are running sufficient Timelords
21+
for testnet consensus.
1222

1323
# Installing
14-
Install instructions are available in the [INSTALL](https://github.com/Chia-Network/chia-blockchain/wiki/INSTALL) section of the [chia-blockchain repository wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
24+
Install instructions are available in the
25+
[INSTALL](https://github.com/Chia-Network/chia-blockchain/wiki/INSTALL)
26+
section of the
27+
[chia-blockchain repository wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
1528

1629
# Running
17-
Once installed, a [Quick Start Guide](https://github.com/Chia-Network/chia-blockchain/wiki/Quick-Start-Guide) is available from the repository [wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
30+
Once installed, a
31+
[Quick Start Guide](https://github.com/Chia-Network/chia-blockchain/wiki/Quick-Start-Guide)
32+
is available from the repository
33+
[wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
1834

1935
# Tips
20-
Ubuntu 18.04 LTS, 19.xx, Amazon Linux 2, and CentOS 7.7 or newer are the easiest linux install environments.
36+
Ubuntu 18.04 LTS, 19.xx, Amazon Linux 2, and CentOS 7.7 or newer are the
37+
easiest linux install environments.
2138

22-
UPnP is enabled by default, to open port 8444 for incoming connections. If this causes issues,
23-
you can disable it in the configuration. Some routers may require port forwarding, or enabling
24-
UPnP in the router configuration.
39+
UPnP is enabled by default, to open port 8444 for incoming connections.
40+
If this causes issues, you can disable it in config.yaml.
41+
Some routers may require port forwarding, or enabling UPnP
42+
in the router's configuration.
2543

26-
Due to the nature of proof of space lookups by the harvester in the current release you should limit
27-
the number of plots on a physical drive to 50 or less. This limit will significantly increase soon.
44+
Due to the nature of proof of space lookups by the harvester in the current
45+
release you should limit the number of plots on a physical drive to 50 or less.
46+
This limit will significantly increase soon.
2847

2948
# uvloop
3049

@@ -33,7 +52,9 @@ For potentially increased networking performance, install uvloop:
3352
pip install -e ".[uvloop]"
3453
```
3554

36-
You can also use the [HTTP RPC](https://github.com/Chia-Network/chia-blockchain/wiki/Networking-and-Serialization#rpc) api to access information and control the full node:
55+
You can also use the
56+
[HTTP RPC](https://github.com/Chia-Network/chia-blockchain/wiki/Networking-and-Serialization#rpc)
57+
api to access information and control the full node:
3758

3859
```bash
3960
curl -X POST http://localhost:8555/get_blockchain_state

0 commit comments

Comments
 (0)