From 48b1edf1d2ae2680b4c21cc00003704dced7977c Mon Sep 17 00:00:00 2001
From: Joshua <61986732+jbjorkang@users.noreply.github.com>
Date: Thu, 26 Oct 2023 10:37:48 +0200
Subject: [PATCH] Update README.md with building instructions

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 25fcabc..69a94fc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # udp-over-tcp
 
+## Introduction
+
 A library (and binaries) for tunneling UDP datagrams over a TCP stream.
 
 Some programs/protocols only work over UDP. And some networks only allow TCP. This is where
@@ -18,6 +20,35 @@ Some programs/protocols only work over UDP. And some networks only allow TCP. Th
   `tcp2udp` continues to accept new incoming TCP connections, and creates a new UDP socket
   for each. So a single `tcp2udp` server can be used to service many `udp2tcp` clients.
 
+## Building
+
+Ensure you have the required dependencies installed on:
+
+### Debian / Ubuntu
+
+Install Rust by following the guides for [Rustup]([url](https://www.rust-lang.org/tools/install))
+
+Install ibc6-dev with APT:
+
+```
+sudo apt install -y libc6-dev
+```
+
+### Fedora
+
+All dependencies can be installed as follows:
+
+```
+sudo dnf install -y cargo rust glibc-static 
+```
+
+Run the script `build-static-bins.sh` to produce the static binary files. These will be outputted to:
+
+```
+$ ls target/x86_64-unknown-linux-gnu/release/
+build  deps  examples  incremental  tcp2udp  tcp2udp.d  udp2tcp  udp2tcp.d
+```
+
 ## Protocol
 
 The format of the data inside the TCP stream is very simple. Each datagram is preceded