Skip to content

Commit 9d172bc

Browse files
committed
docs: move quick start to front page
1 parent fce2b7b commit 9d172bc

File tree

2 files changed

+72
-52
lines changed

2 files changed

+72
-52
lines changed

README.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,75 @@ Monitor and analyze the emergent behaviors of Bitcoin networks.
2525
- [Scaling](/docs/scaling.md)
2626
- [Contributing](/docs/developer-notes.md)
2727

28-
![warnet-art](https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/docs/machines.webp)
28+
29+
## Quick Start
30+
31+
### 1. Create a python virtual environment
32+
33+
```sh
34+
python3 -m venv .venv
35+
source ./venv/bin/activate
36+
```
37+
38+
### 2. Install Warnet
39+
40+
```sh
41+
pip install warnet
42+
```
43+
44+
### 3. Set up dependencies
45+
46+
Warnet will ask which back end you want to use, check that it is working,
47+
and install additional client tools into the virtual environment.
48+
49+
```sh
50+
warnet setup
51+
```
52+
53+
### 4. Create a project and network
54+
55+
Warnet will create a new folder structure containing standard scenario and plugin
56+
files, and prompt for details about a network topology to create. Topology details
57+
include number of Bitcoin nodes, which release versions or custom images to deploy
58+
and how many random graph connections to start each node with.
59+
60+
```sh
61+
warnet new /my/work/stuff/projectname
62+
```
63+
64+
### 5. Deploy the network
65+
66+
```sh
67+
warnet deploy /my/work/stuff/projectname/networks/networkname
68+
```
69+
70+
### 6. Run experiments
71+
72+
For example, you can start mining blocks...
73+
74+
```sh
75+
warnet run /my/work/stuff/projectname/scenarios/miner_std.py
76+
```
77+
78+
... and then observe network connectivity and statistics in your browser:
79+
80+
```sh
81+
warnet dashboard
82+
```
83+
84+
### 7. Shut down the network
85+
86+
```sh
87+
warnet down
88+
```
89+
90+
### 8. Customize
91+
92+
Read the docs and learn how to write your own [scenarios](docs/scenarios.md)
93+
or add [plugins](docs/plugins.md) to your network. [Configure](docs/config.md) individual nodes
94+
in the network by editing the `network.yaml` file or configure
95+
defaults for all nodes in the network by editing `node-defaults.yaml`. Once
96+
your network is running use Warnet [CLI](docs/warnet.md) commands to interact with it.
97+
98+
99+
![warnet-art](https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/docs/machines.webp)

docs/quickstart.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)