From 65bfde65fb2a9ce6e80183c1cbbdae682af0b6da Mon Sep 17 00:00:00 2001
From: ITQ <itq.dev@ya.ru>
Date: Sat, 5 Jul 2025 21:29:44 +0300
Subject: [PATCH] docs: improvements and other stuff

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 44 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 9668492..96f5dfe 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@ Ensure you have the following installed on your system:
 
 - [libvirt](https://libvirt.org/) (latest version recommended)
 - [Terraform](https://developer.hashicorp.com/terraform) (latest version recommended)
+- [Wireshark](https://www.wireshark.org/) (latest version recommended)
 
 ## Deploying environment
 
@@ -23,6 +24,14 @@ cd terraform
 cp .env.template .env
 ```
 
+### Add client and server records to `/etc/hosts`
+
+```bash
+# ...
+10.6.6.10 client
+10.6.6.20 server
+```
+
 ### Init Terraform
 
 ```bash
@@ -55,18 +64,38 @@ curl --http2-prior-knowledge server:81/<size>MB.file -o <size>MB.file
 tftp server -c get /var/www/<size>MB.file
 ```
 
-### Merge `pcap` files
+### Run benchmarks
 
 ```bash
-mergecap -w merged.pcap http1.1-bbr.pcapng http1.1-reno.pcapng http3.pcapng tftp.pcapng
+./scripts/run_benchmarks
 ```
 
-### Change CC
+This script does the following things
+
+#### Change CC (on vms, 4 combinations for `tcp` protocols)
 
 ```bash
 sysctl net.ipv4.tcp_congestion_control=bbr|reno -w
 ```
 
+#### Starts `tcpdump` on hypervisor with filters according to protocol
+
+```bash
+tcpdump -i "$interface" -w "$pcap_file" "$filter"
+```
+
+#### Runs download command according to protocol
+
+Refer to [this](#commands-for-client)
+
+#### Stops `tcpdump`
+
+### Merge `pcap` files
+
+```bash
+mergecap -w merged.pcap dump1 dump2 ...
+```
+
 ### Change link profile
 
 ```bash
@@ -74,3 +103,15 @@ sysctl net.ipv4.tcp_congestion_control=bbr|reno -w
 ```
 
 And follow the instructions
+
+This script just executes this command on `server` vm
+
+```bash
+tc qdisc replace dev $interface root netem delay ${delay}ms loss ${loss}%
+```
+
+OR:
+
+```bash
+tc qdisc del dev $interface root
+```