mongoose/examples
Sergio R. Caprile 3f760e1875
Merge pull request #2111 from cesanta/standex
standardize Zephyr examples
2023-03-08 17:35:39 -03:00
..
arduino/w5500 Move mip/ -> src/tcpip/, rename mip_ -> mg_tcpip_ 2023-02-07 21:35:37 +00:00
captive-dns-server READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
device-dashboard update Makefiles and symlinks 2023-02-22 16:38:21 -03:00
embedded-filesystem READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
esp32 update 2023-03-08 11:44:34 -03:00
esp8266/http-client-server update 2023-03-08 11:44:34 -03:00
file-upload-html-form READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
file-upload-multiple-posts READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
file-upload-single-post READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
http-client Golden Makefiles 2023-02-20 16:20:28 -03:00
http-proxy-client http-proxy-client Makefile 2023-02-21 12:16:39 -03:00
http-restful-server updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
http-reverse-proxy update Makefiles and symlinks 2023-02-22 16:38:21 -03:00
http-server Fix #2075. Add MG_HTTP_DIRLIST_TIME_FMT, remove MG_HTTP_DIRLIST_TIME and MG_HTTP_DIRLIST_TIME_UTC 2023-02-20 21:25:55 +00:00
http-streaming-client updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
huge-response updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
infineon/infineon-xmc4700_4800-lwip-rtx-rtos Add RTX-RTOS support 2022-02-23 19:56:37 +02:00
json-rpc-over-websocket updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
live-log updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
mip-pcap updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
mip-tap updated Makefiles and symlinks 2023-02-21 16:05:25 -03:00
mqtt-client update Makefiles and symlinks 2023-02-22 16:38:21 -03:00
mqtt-client-aws-iot update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
mqtt-over-ws-client update Makefiles and symlinks 2023-02-22 16:38:21 -03:00
mqtt-server update Makefiles and symlinks 2023-02-22 16:38:21 -03:00
multi-threaded READMEs, golden update collaterals, etc 2023-02-21 12:07:48 -03:00
nxp Add more NXP examples and move them to nxp folder 2021-10-22 14:04:15 +03:00
rp2040 Gen MAC from board ID, standardize 2023-03-08 11:51:55 -03:00
smtp-client update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
sntp-time-sync update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
socks5-server update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
stm32 unbreak RNDIS examples 2023-02-27 11:28:42 -03:00
tcp Merge pull request #2092 from cesanta/standex 2023-02-23 19:07:44 -03:00
ti rework serial config 2023-03-07 16:02:02 -03:00
timers update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
uart-bridge fix build for Windows 2023-02-23 14:04:10 -03:00
udp-ssdp-search update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
video-stream update Makefiles and symlinks 2023-02-23 11:32:53 -03:00
websocket-client updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
websocket-server updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-login updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-plain updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-preact updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-push-rest updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-push-ws updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
webui-rest updated Makefiles and symlinks 2023-02-24 13:46:31 -03:00
zephyr standardize Zephyr examples 2023-03-08 16:41:21 -03:00
README.md Fix #2063 - a typo 2023-02-14 15:12:51 +00:00

Mongoose Network Library Examples

In order to build and run any of the existing examples, please follow: https://mongoose.ws/documentation/#how-to-build-and-run-examples

Contributing

Rules for creating a new example:

  • Makefile golden reference for desktop/server example: http-server
  • Makefile golden reference for the embedded example: stm32/nucleo-f746zg-baremetal
  • An example must build on Windows, Mac and Ubuntu Linux systems
  • Assume that user installed tools according to https://mongoose.ws/tutorials/tools/
  • Makefile must not include any other make files
  • Use CFLAGS for system-specific compilation options
  • Use CFLAGS_MONGOOSE for mongoose-specific compilation options
  • Use $(CFLAGS) $(CFLAGS_MONGOOSE) $(CFLAGS_EXTRA) to compile
  • If external repository is required, download it on demand using git shallow clone. See embedded example golden reference
  • Keep Makefile as short as possible, but verbose to understand it easily
  • Symlink files when required, like mongoose.c, ca.pem, etc. Make no copies
  • Example's README.md should contain only the title and the link to mongoose.ws tutorial page