From 274c11c3ecfa99a602e59da2e992bdfc55af03b0 Mon Sep 17 00:00:00 2001 From: cpq Date: Sun, 11 Sep 2022 13:42:59 +0100 Subject: [PATCH] Update README --- README.md | 1 + mip/README.md | 22 ++++++++++++++++------ 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1add61b8..2ba81111 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ robust, and easy. Features include: - Tiny static and run-time footprint - Source code is both ISO C and ISO C++ compliant - Works with any network stack with socket API, like LwIP or FreeRTOS-Plus-TCP +- Optional [built-in IP stack](mip) for bare metal or RTOS-enabled applications - Very easy to integrate: just copy `mongoose.c` and `mongoose.h` files to your build tree - Detailed [documentation](https://mongoose.ws/documentation/) and [tutorials](https://mongoose.ws/tutorials/) diff --git a/mip/README.md b/mip/README.md index 14839908..73096082 100644 --- a/mip/README.md +++ b/mip/README.md @@ -1,9 +1,19 @@ -# MIP - experimental TCP/IP stack for Mongoose Library +# MIP - a built-in TCP/IP stack for Mongoose Library This bare-metal embedded TCP/IP stack is designed specifically for Mongoose. -It does not implement BSD sockets interface - instead, it implements -an event-based API tailored for Mongoose Library. As a result, it does not -need to use synchronisation primitives. It is very fast, and can work -with or without RTOS. +Works with or without RTOS. Makes it possible to implement networking without +any extra software - just drop `mongoose.c` and `mongoose.h` into your sources, +and you're done! -See example usage at [examples/stm32/nucleo-f746zg-baremetal](../examples/stm32/nucleo-f746zg-baremetal) +## Implemented drivers + +- STM32F4xx +- STM32F7xx +- W5500 + +## Example usage + +- [nucleo-f746 bare metal](../examples/stm32/nucleo-f746zg-baremetal) +- [nucleo-f429 bare metal](../examples/stm32/nucleo-f429zi-baremetal) +- (VIDEO) [stm32f7 with CubeIDE](https://www.youtube.com/watch?v=8htC_TSBeO0) +- [Xiao M0 SAMD21 Arduino + W5500](../examples/arduino/w5500)