From c9c94269074cb004493594c90683ed8a28386917 Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Thu, 20 Jul 2023 09:46:41 +0200 Subject: [PATCH 1/5] Create README.me --- READMEs/README.me | 1 + 1 file changed, 1 insertion(+) create mode 100644 READMEs/README.me diff --git a/READMEs/README.me b/READMEs/README.me new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/READMEs/README.me @@ -0,0 +1 @@ + From 8498c02e379a5fc5121dff4d99fe316fa5101f4a Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Thu, 20 Jul 2023 09:48:02 +0200 Subject: [PATCH 2/5] Update README.me --- READMEs/README.me | 1 + 1 file changed, 1 insertion(+) diff --git a/READMEs/README.me b/READMEs/README.me index 8b13789179..ae1649318e 100644 --- a/READMEs/README.me +++ b/READMEs/README.me @@ -1 +1,2 @@ +[Async DNS](./README.async-dns.md) From dfcbfbd0d3428594f563e64d0768f4a8c6607391 Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Thu, 20 Jul 2023 09:48:28 +0200 Subject: [PATCH 3/5] Rename README.me to README.md --- READMEs/{README.me => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename READMEs/{README.me => README.md} (100%) diff --git a/READMEs/README.me b/READMEs/README.md similarity index 100% rename from READMEs/README.me rename to READMEs/README.md From e0ad722bd6de842fd49997c6deea58bc88eea537 Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Thu, 20 Jul 2023 10:43:14 +0200 Subject: [PATCH 4/5] Started on a TOC summary readme for the READMEs folder --- READMEs/README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 71 insertions(+), 1 deletion(-) diff --git a/READMEs/README.md b/READMEs/README.md index ae1649318e..e041cb3d1c 100644 --- a/READMEs/README.md +++ b/READMEs/README.md @@ -1,2 +1,72 @@ +# Overview +To help orient among these readme files, we have listem them here in alphabetical order together with a short abstract / summary. -[Async DNS](./README.async-dns.md) +## [async dns](./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) +## [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) From 261b957cf6283b2e098ff9ec7706dfafc3a664af Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Thu, 20 Jul 2023 10:44:55 +0200 Subject: [PATCH 5/5] Update README.md --- READMEs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/READMEs/README.md b/READMEs/README.md index e041cb3d1c..c7a218d78f 100644 --- a/READMEs/README.md +++ b/READMEs/README.md @@ -54,6 +54,8 @@ This document provides essential notes for compiling libwebsockets on a Windows ## [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)