From c8afb99be8bea41ebaf98a92c6225bc3cc0d8783 Mon Sep 17 00:00:00 2001
From: Tristan <tristan@mangadex.org>
Date: Mon, 6 Jun 2022 07:35:05 +0100
Subject: [PATCH] Update README

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 40 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 10f0ce1..87a15e9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,43 @@
-# HAProxy Mainline
+# HAProxy
 
-###### Builds of HAProxy's mainline. Release and dev branch tips.
+Build scripts for HAProxy with QUIC
 
-Docs tbd. HAProxy = <3
+## Get started
 
+You will need the following dependencies (Debian/Ubuntu packages given as example):
+
+- Development tools (`build-essential`)
+- curl and ssl support for it (`curl` and `ca-certificates`)
+- CMake (`cmake`)
+- Readline library headers (`libreadline-dev`)
+- Libsystemd headers (`libsystemd-dev`)
+- GNU TAR (`tar`)
+
+Then just run `make` and the build should pass.
+
+You then need to unpack `deps/quictls/quictls-OpenSSL_1_1_1o-dist.tar.gz` so
+that it expands in `/opt/quictls`, which is where HAProxy will look for OpenSSL.
+
+And finally you can expand `haproxy/haproxy-2.6-dist.tar.gz` wherever you please.
+
+## Should I use this repo?
+
+This is an:
+- unofficial build of HAProxy
+- which enables an experimental feature of HAProxy
+- which relies on an unofficial build of OpenSSL
+- which is based on an unofficial patch of OpenSSL
+
+Generally speaking, you shouldn't.
+
+That said, please PR improvements back if you do. We'll be using it ourselves too.
+
+## What's in there
+
+First, we want to statically build things where possible, which is done for:
+- LUA
+- PCRE2
+- QuicTLS
+
+Then we want HAProxy to not use the system's OpenSSL but rather our QuicTLS build, which
+it will look for at the `/opt/quictls` prefix.