mirror of
https://github.com/cesanta/mongoose.git
synced 2024-12-14 16:49:26 +08:00
6a7129d7af
pilot move to new skeleton in examples |
||
---|---|---|
.. | ||
arduino | ||
device-dashboard | ||
esp32 | ||
esp8266/http-client-server | ||
file-transfer | ||
infineon | ||
microchip/same54-xpro | ||
micropython | ||
modbus-dashboard | ||
mqtt-dashboard | ||
nxp | ||
renesas/ek-ra6m4-make-baremetal-builtin | ||
rp2040 | ||
stm32 | ||
ti | ||
uart-bridge | ||
wch/ch32v307-make-baremetal-builtin | ||
wifi-router-dashboard | ||
zephyr | ||
README.md |
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