Skip to content

Commit d1fb1e1

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

File tree

2 files changed

+73
-52
lines changed

2 files changed

+73
-52
lines changed

README.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Monitor and analyze the emergent behaviors of Bitcoin networks.
1010
* Collect and search data from nodes including log files and p2p messages.
1111
* Monitor and visualize performance data from Bitcoin nodes.
1212
* Connect to a large network running in a remote cluster, or a smaller network running locally.
13+
* Add a Lightning Network with its own channel topology and payment activity.
1314

1415
## Documentation
1516

@@ -25,4 +26,75 @@ Monitor and analyze the emergent behaviors of Bitcoin networks.
2526
- [Scaling](/docs/scaling.md)
2627
- [Contributing](/docs/developer-notes.md)
2728

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