From 07b1c27eb94700d813d487aa5fadf0dbb28800a2 Mon Sep 17 00:00:00 2001
From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com>
Date: Mon, 13 Nov 2023 09:26:18 +0000
Subject: [PATCH] READMEs: add overview README with links

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

diff --git a/READMEs/README.md b/READMEs/README.md
new file mode 100644
index 0000000000..d0d47a6f00
--- /dev/null
+++ b/READMEs/README.md
@@ -0,0 +1,74 @@
+# Overview
+To help orient among these readme files, we have listem them here in alphabetical order together with a short abstract / summary.
+
+## [async dns](READMEs/README.async-dns.md)
+Learn about Asynchronous DNS in Lws, enabling non-blocking and caching DNS resolution on the event loop. Discover its integrated features, like IPv4/IPv6 support, LRU caching, and CNAME resolution. Perfect for latency-sensitive applications.
+
+## [build android](./README.build-android.md)
+Using Lws for Android with NDK and prebuilt toolchains. Integrate TLS library (mbed TLS) effortlessly. Install both libraries and header files in NDK cross root for seamless Android project integration.
+
+## [build windows](./README.build-windows.md)
+This document provides essential notes for compiling libwebsockets on a Windows system. It offers step-by-step instructions, including setting up a Windows virtual machine, installing necessary tools such as CMake, Git, and OpenSSL, and building pthreads compatibility. The process also covers cloning libwebsockets, using CMake for building, and installing the library. Additionally, it includes a workaround for using paths with spaces in CMake.
+
+## [build](./README.build.md)
+## [captive portal detection](./README.captive-portal-detection.md)
+## [cbor cose](./README.cbor-cose.md)
+## [cbor lecp](./README.cbor-lecp.md)
+## [ci](./README.ci.md)
+## [cmake](./README.cmake.md)
+## [coding](./README.coding.md)
+## [content security policy](./README.content-security-policy.md)
+## [contributing](./README.contributing.md)
+## [crypto apis](./README.crypto-apis.md)
+## [ctest](./README.ctest.md)
+## [debugging](./README.debugging.md)
+## [display list](./README.display-list.md)
+## [esp32](./README.esp32.md)
+## [event libs](./README.event-libs.md)
+## [event loops intro](./README.event-loops-intro.md)
+## [fault injection](./README.fault-injection.md)
+## [h2 long poll](./README.h2-long-poll.md)
+## [html parser](./README.html-parser.md)
+## [http cache](./README.http-cache.md)
+## [http fallback](./README.http-fallback.md)
+## [http parser](./README.http_parser.md)
+## [jit trust](./README.jit-trust.md)
+## [jpeg decoder](./README.jpeg-decoder.md)
+## [json lejp](./README.json-lejp.md)
+## [jwt](./README.jwt.md)
+## [libressl](./README.libressl.md)
+## [lifecycle](./README.lifecycle.md)
+## [logging](./README.logging.md)
+## [lws backtrace](./README.lws_backtrace.md)
+## [lws cache](./README.lws_cache.md)
+## [lws conmon](./README.lws_conmon.md)
+## [lws dll](./README.lws_dll.md)
+## [lws fixed3232](./README.lws_fixed3232.md)
+## [lws map](./README.lws_map.md)
+## [lws metrics](./README.lws_metrics.md)
+## [lws ota](./README.lws_ota.md)
+## [lws plugins](./README.lws_plugins.md)
+## [lws retry](./README.lws_retry.md)
+## [lws struct](./README.lws_struct.md)
+## [lws sul](./README.lws_sul.md)
+## [lws system](./README.lws_system.md)
+## [lwsws](./README.lwsws.md)
+## [README](./README.md)
+This README.md file, see top of file for description.
+
+## [plugin acme](./README.plugin-acme.md)
+## [plugin sshd base](./README.plugin-sshd-base.md)
+## [png decoder](./README.png-decoder.md)
+## [porting](./README.porting.md)
+## [problems](./README.problems.md)
+## [release policy](./README.release-policy.md)
+## [routing](./README.routing.md)
+## [secure streams](./README.secure-streams.md)
+## [tcp fastopen](./README.tcp_fastopen.md)
+## [test apps](./README.test-apps.md)
+## [tls sessions](./README.tls-sessions.md)
+## [udp](./README.udp.md)
+## [unix domain reverse proxy](./README.unix-domain-reverse-proxy.md)
+## [vulnerability reporting](./README.vulnerability-reporting.md)
+## [mainpage](./mainpage.md)
+## [release checklist](./release-checklist)