From 5cc1100b6e3b244ae6469c9636040d43e28a5331 Mon Sep 17 00:00:00 2001
From: lunar-mining <ihateface@autistici.org>
Date: Mon, 13 Nov 2023 13:36:13 +0100
Subject: [PATCH] dnet: add venv instructions to README and do minor edit

---
 bin/dnet/README.md | 44 +++++++++++++++++++++++++++++++++++---------
 1 file changed, 35 insertions(+), 9 deletions(-)

diff --git a/bin/dnet/README.md b/bin/dnet/README.md
index 403c302e8..a2a351177 100644
--- a/bin/dnet/README.md
+++ b/bin/dnet/README.md
@@ -13,21 +13,47 @@ engine that makes everything run.
 
 ## Run
 
+### Using a venv
+
+Depending on your setup you may need to install a virtual environment
+for Python. Do so as follows:
+
 ```shell
-% git clone https://github.com/darkrenaissance/darkfi 
-% cd darkfi/bin/dnet
+% python -m venv env
+```
+
+Then install the requirements:
+
+```shell
+% env/bin/pip install -r requirements.txt
+```
+
+Run dnet:
+
+```shell
+% env/bin/python main.py
+```
+
+### Without a venv
+
+If you don't require a venv, install the requirements and run dnet as follows:
+
+```shell
+% pip install -r requirements.txt
 % python main.py
 ```
 
-Navigate up and down using the arrow keys. Type `q` to quit.
-
 ## Usage
 
-The `dnet` config file can be found in `bin/dnet/config.toml`. You must
-enter the RPC ports of the nodes you want to connect to and title them as
-you see fit. You must also specify whether it is a `NORMAL` or a `LILITH`
-node. The default config file uses localhost, but you can replace this
-with hostnames or external IP addresses.
+Navigate up and down using the arrow keys. Type `q` to quit.
+
+## Config
+
+The `dnet` config file can be found in `bin/dnet/config.toml`. Enter the
+RPC ports of the nodes you want to connect to and title them as you see
+fit. The default config file uses localhost, but you can replace this
+with hostnames or external IP addresses. You must also specify whether
+it is a `NORMAL` or a `LILITH` node.
 
 ## Logging