From 168350fdb682ac0cc3c98423fc8e34c4280e7f84 Mon Sep 17 00:00:00 2001 From: talksik Date: Sat, 27 Jan 2024 12:15:37 -0800 Subject: [PATCH 1/3] adjusting to include full install --- GNUmakefile | 2 ++ misc/READMORE.md | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/GNUmakefile b/GNUmakefile index 6b19b7058..d6719979c 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -13,6 +13,8 @@ capi: default ./build capi install: + cp uSockets/uSockets.a "$(DESTDIR)$(prefix)/lib" + cp uSockets/src/libusockets.h "$(DESTDIR)$(prefix)/include" mkdir -p "$(DESTDIR)$(prefix)/include/uWebSockets" cp -r src/* "$(DESTDIR)$(prefix)/include/uWebSockets" diff --git a/misc/READMORE.md b/misc/READMORE.md index 93fde858b..d1fc82361 100644 --- a/misc/READMORE.md +++ b/misc/READMORE.md @@ -38,6 +38,13 @@ There are a few compilation flags for µSockets (see its documentation), but com You can use the Makefile on Linux and macOS. It is simple to use and builds the examples for you. `WITH_OPENSSL=1 make` builds all examples with SSL enabled. Examples will fail to listen if cert and key cannot be found, so make sure to specify a path that works for you. +### Steps +```sh +git clone --resurse-submodules https://github.com/uNetworking/uWebSockets +make # prepend variables if desired such as `WITH_OPENSSL` as mentioned above +make install +``` + ## User manual ### uWS::App & uWS::SSLApp From b7e2abd6203dfd7526d41a25f55df5300390b181 Mon Sep 17 00:00:00 2001 From: talksik Date: Sat, 27 Jan 2024 12:18:03 -0800 Subject: [PATCH 2/3] adding instructions for CMake users --- misc/READMORE.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/misc/READMORE.md b/misc/READMORE.md index d1fc82361..1ec942d1a 100644 --- a/misc/READMORE.md +++ b/misc/READMORE.md @@ -38,13 +38,24 @@ There are a few compilation flags for µSockets (see its documentation), but com You can use the Makefile on Linux and macOS. It is simple to use and builds the examples for you. `WITH_OPENSSL=1 make` builds all examples with SSL enabled. Examples will fail to listen if cert and key cannot be found, so make sure to specify a path that works for you. -### Steps +### Steps for Linux ```sh git clone --resurse-submodules https://github.com/uNetworking/uWebSockets make # prepend variables if desired such as `WITH_OPENSSL` as mentioned above make install ``` +_Note for Linux CMake users: make sure to include ZLIB as a dependency as well as `uSockets.a` static library (which was installed during `make install`)._ + +Here is an example: +``` +... +find_library(USOCKETS_LIBRARY uSockets.a PATHS /usr/local/lib REQUIRED) +find_package(ZLIB REQUIRED) +target_link_libraries(${PROJECT_NAME} ${USOCKETS_LIBRARY} ZLIB::ZLIB) +... +``` + ## User manual ### uWS::App & uWS::SSLApp From 92205ee9e509ba6f808d491144017628cb212fc8 Mon Sep 17 00:00:00 2001 From: talksik Date: Tue, 26 Nov 2024 12:47:55 -0800 Subject: [PATCH 3/3] fix typo --- misc/READMORE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/misc/READMORE.md b/misc/READMORE.md index 1ec942d1a..9897855fd 100644 --- a/misc/READMORE.md +++ b/misc/READMORE.md @@ -40,7 +40,7 @@ You can use the Makefile on Linux and macOS. It is simple to use and builds the ### Steps for Linux ```sh -git clone --resurse-submodules https://github.com/uNetworking/uWebSockets +git clone --recurse-submodules https://github.com/uNetworking/uWebSockets make # prepend variables if desired such as `WITH_OPENSSL` as mentioned above make install ```