From 94413680cf95ac297bac8852a65f223b7ac8af96 Mon Sep 17 00:00:00 2001 From: Nakidai Date: Fri, 13 Dec 2024 14:50:40 +0300 Subject: Add generated README --- Makefile | 3 +++ README | 30 ++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 README diff --git a/Makefile b/Makefile index 7c11323..ceae766 100644 --- a/Makefile +++ b/Makefile @@ -26,6 +26,9 @@ libhttpc.so: libhttpc.a: ar rcs $@ $^ +README: + mandoc -T ascii $@.7 | col -b > $@ + install: all install -d $(DESTDIR)/lib ${DESTDIR}/include/libhttpc ${DESTDIR}/share/man/man3 install -m644 libhttpc.a $(DESTDIR)/lib diff --git a/README b/README new file mode 100644 index 0000000..0cdee1a --- /dev/null +++ b/README @@ -0,0 +1,30 @@ +LIBHTTPC(7) Miscellaneous Information Manual LIBHTTPC(7) + +NAME + libhttpc - HTTP Library (Cute :3) + +DESCRIPTION + This library provides some QoL function for parsing requests and + constructing responses. It's written for making HTTP servers. + + If you want to check the documentation, you may want to check + include/libhttpc.h file or libhttpc(3) + +EXAMPLES + As an example, I can tell you the way how personally I use this library: + + o Receive request from the user + + o Pass the request to the libhttpc_loadrequest(3) function + + o Handle the request + + o Send request back using libhttpc_dumpresponse(3) + +SEE ALSO + libhttpc(3) + +AUTHORS + Nakidai Perumenei + +Linux 6.12.1-arch1-1 December 13, 2024 Linux 6.12.1-arch1-1 -- cgit 1.4.1