READMEs, golden update collaterals, etc

examples/captive-dns-server/Makefile

@@ -1,28 +1,25 @@
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
 SOURCES = main.c mongoose.c       # Source code files
 CFLAGS = -W -Wall -Wextra -g -I.  # Build options
 
 # Mongoose build options. See https://mongoose.ws/documentation/#build-options
 CFLAGS_MONGOOSE += -DMG_IO_SIZE=8192 -DMG_ENABLE_LINES
 
-ifeq ($(OS),Windows_NT)
-  # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
   PROG ?= example.exe           # Use .exe suffix for the binary
   CC = gcc                      # Use MinGW gcc compiler
   CFLAGS += -lws2_32            # Link against Winsock library
   DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
   OUT ?= -o $(PROG)             # Build output
-else
-  # Mac, Linux
-  PROG ?= example
-  DELETE = rm -rf
-  OUT ?= -o $(PROG)
 endif
 
-all: $(PROG)
+all: $(PROG)              # Default target. Build and run program
 	$(RUN) ./$(PROG) $(ARGS)
 
-$(PROG): $(SOURCES)
+$(PROG): $(SOURCES)       # Build program from sources
 	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
 
-clean:
+clean:                    # Cleanup. Delete built program and all build artifacts
 	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM

examples/device-dashboard/Makefile

@@ -1,24 +1,22 @@
-SOURCES = mongoose.c main.c net.c packed_fs.c # Source code files
-CFLAGS = -W -Wall -Wextra -g -I.              # Build options
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
+SOURCES = main.c mongoose.c net.c packed_fs.c      # Source code files
+CFLAGS = -W -Wall -Wextra -g -I.  # Build options
 
 # Mongoose build options. See https://mongoose.ws/documentation/#build-options
 CFLAGS_MONGOOSE += -DMG_ENABLE_PACKED_FS=1
 
-ifeq ($(OS),Windows_NT)
-  # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
   PROG ?= example.exe           # Use .exe suffix for the binary
   CC = gcc                      # Use MinGW gcc compiler
   CFLAGS += -lws2_32            # Link against Winsock library
   DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
   OUT ?= -o $(PROG)             # Build output
-else
-  # Mac, Linux
-  PROG ?= example
-  DELETE = rm -rf
-  OUT ?= -o $(PROG)
+  MAKE += WINDOWS=1 CC=$(CC)
 endif
 
-all: $(PROG)
+all: $(PROG)              # Default target. Build and run program
 	$(RUN) ./$(PROG) $(ARGS)
 
 ifneq ($(OS),Windows_NT)
@@ -30,8 +28,14 @@ packed_fs.c: $(shell find web_root -type f) Makefile
 	cd tmp && ../pack `find web_root -type f` > ../$@
 endif
 
-$(PROG): $(SOURCES)
+$(PROG): $(SOURCES)       # Build program from sources
 	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
 
-clean:
-	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM pack tmp
+clean:                    # Cleanup. Delete built program and all build artifacts
+	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM pack tmp mbedtls
+
+# see https://mongoose.ws/tutorials/tls/#how-to-build for TLS build options
+
+mbedtls:                  # Pull and build mbedTLS library
+	git clone --depth 1 -b v2.28.2 https://github.com/mbed-tls/mbedtls $@
+	$(MAKE) -C mbedtls/library

examples/embedded-filesystem/Makefile

@@ -1,41 +1,38 @@
-SOURCES = mongoose.c main.c packed_fs.c  # Source code files
-CFLAGS = -W -Wall -Wextra -g -I.         # Build options
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
+SOURCES = main.c mongoose.c packed_fs.c      # Source code files
+CFLAGS = -W -Wall -Wextra -g -I.  # Build options
+PACK = ./pack             # Utility to pack files into a packed filesystem
 
 # Mongoose build options. See https://mongoose.ws/documentation/#build-options
 CFLAGS_MONGOOSE += -DMG_ENABLE_PACKED_FS=1
 
 FILES_TO_EMBED ?= $(wildcard web_root/*)
 
-ifeq ($(OS),Windows_NT)
-  # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
   PROG ?= example.exe           # Use .exe suffix for the binary
   CC = gcc                      # Use MinGW gcc compiler
   CFLAGS += -lws2_32            # Link against Winsock library
   DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
   OUT ?= -o $(PROG)             # Build output
   PACK = pack.exe
-else
-  # Mac, Linux
-  PROG ?= example
-  DELETE = rm -rf
-  OUT ?= -o $(PROG)
-  PACK = ./pack
 endif
 
-all: $(PROG)
+all: $(PROG)              # Default target. Build and run program
 	$(RUN) ./$(PROG) $(ARGS)
 
-$(PROG): $(SOURCES) $(FILES_TO_EMBED)
+$(PROG): $(SOURCES) $(FILES_TO_EMBED)       # Build program from sources
 	$(CC) ../../test/pack.c -o $(PACK)
 	$(PACK) $(FILES_TO_EMBED) > packed_fs.c
 	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
 
-clean:
+clean:                    # Cleanup. Delete built program and all build artifacts
 	$(DELETE) $(PROG) *.dSYM $(PACK)
 
 .PHONY: compress expand gzipped plain all
 
-# See tutorial
+# See tutorial at https://mongoose.ws/tutorials/embedded-filesystem/#build-and-try
 gzipped: compress
 	$(MAKE) all
 

examples/file-upload-html-form/Makefile

@@ -1,10 +1,25 @@
-PROG ?= example
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
+SOURCES = main.c mongoose.c       # Source code files
+CFLAGS = -W -Wall -Wextra -g -I.  # Build options
 
-all: $(PROG)
-	$(DEBUGGER) ./$(PROG)
+# Mongoose build options. See https://mongoose.ws/documentation/#build-options
+#CFLAGS_MONGOOSE += -DMG_ENABLE_LINES
 
-$(PROG):
-	$(CC) ../../mongoose.c -I../.. $(CFLAGS) $(EXTRA) -o $(PROG) main.c
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+  PROG ?= example.exe           # Use .exe suffix for the binary
+  CC = gcc                      # Use MinGW gcc compiler
+  CFLAGS += -lws2_32            # Link against Winsock library
+  DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
+  OUT ?= -o $(PROG)             # Build output
+endif
 
-clean:
-	rm -rf $(PROG) *.o *.dSYM *.gcov *.gcno *.gcda *.obj *.exe *.ilk *.pdb log.txt
+all: $(PROG)              # Default target. Build and run program
+	$(RUN) ./$(PROG) $(ARGS)
+
+$(PROG): $(SOURCES)       # Build program from sources
+	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
+
+clean:                    # Cleanup. Delete built program and all build artifacts
+	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM

examples/file-upload-html-form/main.c

@@ -35,6 +35,7 @@ static void cb(struct mg_connection *c, int ev, void *ev_data, void *fn_data) {
       mg_http_serve_dir(c, ev_data, &opts);
     }
   }
+  (void) fn_data;
 }
 
 int main(void) {

examples/file-upload-html-form/mongoose.c

@@ -0,0 +1 @@
+../../mongoose.c

examples/file-upload-html-form/mongoose.h

@@ -0,0 +1 @@
+../../mongoose.h

examples/file-upload-multiple-posts/Makefile

@@ -1,10 +1,25 @@
-PROG ?= example
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
+SOURCES = main.c mongoose.c       # Source code files
+CFLAGS = -W -Wall -Wextra -g -I.  # Build options
 
-all: $(PROG)
-	$(DEBUGGER) ./$(PROG)
+# Mongoose build options. See https://mongoose.ws/documentation/#build-options
+#CFLAGS_MONGOOSE += -DMG_ENABLE_LINES
 
-$(PROG):
-	$(CC) ../../mongoose.c -I../.. $(CFLAGS) $(EXTRA) -o $(PROG) main.c
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+  PROG ?= example.exe           # Use .exe suffix for the binary
+  CC = gcc                      # Use MinGW gcc compiler
+  CFLAGS += -lws2_32            # Link against Winsock library
+  DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
+  OUT ?= -o $(PROG)             # Build output
+endif
 
-clean:
-	rm -rf $(PROG) *.o *.dSYM *.gcov *.gcno *.gcda *.obj *.exe *.ilk *.pdb log.txt
+all: $(PROG)              # Default target. Build and run program
+	$(RUN) ./$(PROG) $(ARGS)
+
+$(PROG): $(SOURCES)       # Build program from sources
+	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
+
+clean:                    # Cleanup. Delete built program and all build artifacts
+	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM

examples/file-upload-multiple-posts/main.c

@@ -23,11 +23,11 @@ static void cb(struct mg_connection *c, int ev, void *ev_data, void *fn_data) {
       mg_http_serve_dir(c, ev_data, &opts);
     }
   }
+  (void) fn_data;
 }
 
 int main(void) {
   struct mg_mgr mgr;
-  struct mg_timer t1;
 
   mg_mgr_init(&mgr);
   mg_log_set(MG_LL_DEBUG);  // Set log level

examples/file-upload-multiple-posts/mongoose.c

@@ -0,0 +1 @@
+../../mongoose.c

examples/file-upload-multiple-posts/mongoose.h

@@ -0,0 +1 @@
+../../mongoose.h

examples/file-upload-single-post/Makefile

@@ -1,10 +1,25 @@
-PROG ?= example
+PROG ?= example                   # Program we are building
+DELETE = rm -rf                   # Command to remove files
+OUT ?= -o $(PROG)                 # Compiler argument for output file
+SOURCES = main.c mongoose.c       # Source code files
+CFLAGS = -W -Wall -Wextra -g -I.  # Build options
 
-all: $(PROG)
-	$(DEBUGGER) ./$(PROG)
+# Mongoose build options. See https://mongoose.ws/documentation/#build-options
+#CFLAGS_MONGOOSE += -DMG_ENABLE_LINES
 
-$(PROG):
-	$(CC) ../../mongoose.c -I../.. $(CFLAGS) $(EXTRA) -o $(PROG) main.c
+ifeq ($(OS),Windows_NT)   # Windows settings. Assume MinGW compiler. To use VC: make CC=cl CFLAGS=/MD OUT=/Feprog.exe
+  PROG ?= example.exe           # Use .exe suffix for the binary
+  CC = gcc                      # Use MinGW gcc compiler
+  CFLAGS += -lws2_32            # Link against Winsock library
+  DELETE = cmd /C del /Q /F /S  # Command prompt command to delete files
+  OUT ?= -o $(PROG)             # Build output
+endif
 
-clean:
-	rm -rf $(PROG) *.o *.dSYM *.gcov *.gcno *.gcda *.obj *.exe *.ilk *.pdb log.txt
+all: $(PROG)              # Default target. Build and run program
+	$(RUN) ./$(PROG) $(ARGS)
+
+$(PROG): $(SOURCES)       # Build program from sources
+	$(CC) $(SOURCES) $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) $(OUT)
+
+clean:                    # Cleanup. Delete built program and all build artifacts
+	$(DELETE) $(PROG) *.o *.obj *.exe *.dSYM

examples/file-upload-single-post/main.c

@@ -26,6 +26,7 @@ static void cb(struct mg_connection *c, int ev, void *ev_data, void *fn_data) {
     struct mg_http_serve_opts opts = {.root_dir = "web_root"};
     mg_http_serve_dir(c, hm, &opts);
   }
+  (void) fn_data;
 }
 
 int main(void) {

examples/file-upload-single-post/mongoose.c

@@ -0,0 +1 @@
+../../mongoose.c

examples/file-upload-single-post/mongoose.h

@@ -0,0 +1 @@
+../../mongoose.h

examples/http-proxy-client/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/http-proxy-client/ 

examples/http-proxy-client/main.c

@@ -5,7 +5,7 @@
 //    make
 //    ./example PROXY:PORT http://www.ladyada.net
 //
-// To enable SSL/TLS, make SSL=OPENSSL or make SSL=MBEDTLS 
+// To enable SSL/TLS, see https://mongoose.ws/tutorials/tls/#how-to-build
 //
 #include "mongoose.h"
 

examples/http-proxy-client/mongoose.c

@@ -0,0 +1 @@
+../../mongoose.c

examples/http-proxy-client/mongoose.h

@@ -0,0 +1 @@
+../../mongoose.h

examples/http-restful-server/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/http-server/

examples/http-restful-server/main.c

@@ -9,7 +9,7 @@
 //    any other URI serves static files from s_root_dir
 //
 // To enable SSL/TLS (using self-signed certificates in PEM files),
-//    1. make SSL=OPENSSL or make SSL=MBEDTLS
+//    1. See https://mongoose.ws/tutorials/tls/#how-to-build
 //    2. curl -k https://127.0.0.1:8443
 
 #include "mongoose.h"

examples/http-reverse-proxy/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/http-reverse-proxy/

examples/http-reverse-proxy/main.c

@@ -5,7 +5,7 @@
 //    1. Run `make`. This builds and starts a proxy on port 8000
 //    2. Start your browser, go to https://localhost:8000
 //
-// To enable SSL/TLS, add SSL=OPENSSL or SSL=MBEDTLS
+// To enable SSL/TLS, see https://mongoose.ws/tutorials/tls/#how-to-build
 
 static const char *s_backend_url =
 #if defined(MG_ENABLE_MBEDTLS) || defined(MG_ENABLE_OPENSSL)

examples/http-streaming-client/main.c

@@ -9,9 +9,7 @@
 //
 // You can change `s_url` from the command line by executing: ./example YOUR_URL
 //
-// To enable SSL/TLS for this client, build it like this:
-//    make MBEDTLS=/path/to/your/mbedtls/installation
-//    make OPENSSL=/path/to/your/openssl/installation
+// To enable SSL/TLS, see https://mongoose.ws/tutorials/tls/#how-to-build
 
 #include "mongoose.h"
 

examples/huge-response/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/huge-response/

examples/live-log/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-push/

examples/mqtt-client/main.c

@@ -8,7 +8,7 @@
 //    4. Receives that message back from the subscribed topic and closes
 //    5. Timer-based reconnection logic revives the connection when it is down
 //
-// To enable SSL/TLS, make SSL=OPENSSL or make SSL=MBEDTLS 
+// To enable SSL/TLS, see https://mongoose.ws/tutorials/tls/#how-to-build
 
 #include "mongoose.h"
 

examples/mqtt-over-ws-client/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/mqtt-over-ws-client/

examples/mqtt-over-ws-client/main.c

@@ -7,7 +7,7 @@
 //    3. Publishes message `hello` to the `s_topic`
 //    4. Receives that message back from the subscribed topic and exits
 //
-// To enable SSL/TLS, make SSL=OPENSSL or make SSL=MBEDTLS
+// To enable SSL/TLS, see https://mongoose.ws/tutorials/tls/#how-to-build
 
 #include "mongoose.h"
 

examples/multi-threaded/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/multi-threaded/

examples/rp2040/pico-w/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/rp2040/pico-w/

examples/sntp-time-sync/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/sntp-time-sync/

examples/socks5-server/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/socks5-server/

examples/tcp/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/tcp/

examples/timers/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/timers/

examples/udp-ssdp-search/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/udp-ssdp-search/

examples/video-stream/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/video-stream/

examples/webui-login/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-login/

examples/webui-plain/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-plain/

examples/webui-preact/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-preact/

examples/webui-push-rest/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-push/

examples/webui-push-ws/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-push/

examples/webui-rest/README.md

@@ -0,0 +1 @@
+See detailed tutorial at https://mongoose.ws/tutorials/webui-rest/