1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-09 00:00:04 +01:00

Started on a TOC summary readme for the READMEs folder

This commit is contained in:
VictorieeMan 2023-07-20 10:43:14 +02:00 committed by GitHub
parent dfcbfbd0d3
commit e0ad722bd6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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)