Skip to content

Commit a28d262

Browse files
committed
document FO access via landing page
1 parent 258fb0a commit a28d262

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

docs/quickstart.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Quick run
2+
3+
## Installation
4+
5+
Either install warnet via pip, or clone the source and install:
6+
7+
### via pip
8+
9+
You can install warnet via `pip` into a virtual environment with
10+
11+
```bash
12+
python3 -m venv .venv
13+
source .venv/bin/activate
14+
pip install warnet
15+
```
16+
17+
### via cloned source
18+
19+
You can install warnet from source into a virtual environment with
20+
21+
```bash
22+
git clone https://github.com/bitcoin-dev-project/warnet.git
23+
cd warnet
24+
python3 -m venv .venv
25+
source .venv/bin/activate
26+
pip install -e .
27+
```
28+
29+
## Running
30+
31+
To get started first check you have all the necessary requirements:
32+
33+
```bash
34+
warnet setup
35+
```
36+
37+
Then create your first network:
38+
39+
```bash
40+
# Create a new network in the current directory
41+
warnet init
42+
43+
# Or in a directory of choice
44+
warnet new <directory>
45+
```
46+
47+
Follow the guide to configure network variables.
48+
49+
## fork-observer
50+
51+
If you enabled [fork-observer](https://github.com/0xB10C/fork-observer), it will be available from the landing page at `localhost:2019`.

0 commit comments

Comments
 (0)