From 3262f37229880f781818e5b932d35ca1d832b123 Mon Sep 17 00:00:00 2001
From: Pavel 'LEdoian' Turinsky <ledoian@matfyz.cz>
Date: Mon, 25 Apr 2022 02:12:12 +0200
Subject: [PATCH] Add a simple README with instructions

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7866a9d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+This is a simple tool to generate testing networks of virtual machines. It was
+written primarilly for my bachelor's thesis.
+
+# Usage:
+
+1. Edit `gen_machines.py` to define the desired network
+2. Optionally edit the templates of config files
+3. Run it
+4. Create pre-installed Alpine Linux 3.15.4 disk image in `dummydisk.img`
+5. Run `gen_disks.sh` as root – this creates customized disk images for all the machines
+6. Append `output/bridge.conf` to your `/etc/qemu/bridge.conf` in order to be able to connect your VMs to bridges as regular user